diff --git a/.brazil.json b/.brazil.json index e1a4ab8c75e..28941f11d4b 100644 --- a/.brazil.json +++ b/.brazil.json @@ -8,7 +8,8 @@ "org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.*": "KotlinxCoroutinesCoreJvm-1.x", "org.jetbrains.kotlinx:kotlinx-coroutines-jdk8:1.*": "KotlinxCoroutinesJdk8-1.x", "com.google.devtools.ksp:symbol-processing-api:2.*": "Maven-com-google-devtools-ksp_symbol-processing-api-2.x", - "com.google.devtools.ksp:symbol-processing-gradle-plugin:2.*": "Maven-com-google-devtools-ksp_symbol-processing-gradle-plugin-2.x" + "com.google.devtools.ksp:symbol-processing-gradle-plugin:2.*": "Maven-com-google-devtools-ksp_symbol-processing-gradle-plugin-2.x", + "com.google.devtools.ksp:com.google.devtools.ksp.gradle.plugin:2.*": "Maven-com-google-devtools-ksp_com_google_devtools_ksp_gradle_plugin-2.x" }, "packageHandlingRules": { "versioning": { diff --git a/.github/workflows/merge-main.yml b/.github/workflows/merge-main.yml index d73d47a838a..8924b931f74 100644 --- a/.github/workflows/merge-main.yml +++ b/.github/workflows/merge-main.yml @@ -14,4 +14,4 @@ jobs: uses: awslabs/aws-kotlin-repo-tools/.github/actions/merge-main@main with: ci-user-pat: ${{ secrets.CI_USER_PAT }} - exempt-branches: # Add any if required \ No newline at end of file + exempt-branches: # Add any if required diff --git a/.github/workflows/sync-mirror.yml b/.github/workflows/sync-mirror.yml index 606a87e7039..bc806b75fef 100644 --- a/.github/workflows/sync-mirror.yml +++ b/.github/workflows/sync-mirror.yml @@ -19,4 +19,4 @@ jobs: source_repo: "https://aws-sdk-kotlin-ci:${{ secrets.CI_USER_PAT }}@github.com/awslabs/aws-sdk-kotlin.git" source_branch: "main" destination_repo: "https://aws-sdk-kotlin-ci:${{ secrets.CI_USER_PAT }}@github.com/awslabs/private-aws-sdk-kotlin-staging.git" - destination_branch: "main" \ No newline at end of file + destination_branch: "main" diff --git a/CHANGELOG.md b/CHANGELOG.md index 66b6597967d..58361f40151 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,158 @@ # Changelog +## [1.5.11] - 08/05/2025 + +### Features +* (**bedrock**) This release introduces Automated Reasoning checks for Amazon Bedrock Guardrails. The feature adds new APIs for policy building, refinement, version management, and testing. Guardrail APIs now support Automated Reasoning policy configuration and validation output. +* (**bedrockruntime**) This release adds support for Automated Reasoning checks output models for the Amazon Bedrock Guardrails ApplyGuardrail API. +* (**eks**) Add support for deletion protection on EKS clusters +* (**rds**) Adds a new Aurora Serverless v2 attribute to the DBCluster resource to expose the platform version. Also updates the attribute to be part of both the engine version and platform version descriptions. +* (**sagemaker**) Add support for SageMaker Hyperpod continuous scaling and custom AMI; Introduce new APIs: ListClusterEvents, DescribeClusterEvent, BatchAddClusterNodes + +## [1.5.10] - 08/04/2025 + +### Features +* (**bedrockagentcore**) Remove superfluous field from API +* (**codeconnections**) New integration with Azure DevOps provider type. +* (**evs**) TagResource API now throws ServiceQuotaExceededException when the number of tags on the Amazon EVS resource exceeds the maximum allowed. TooManyTagsException is deprecated. +* (**iotsitewise**) Support Interface for IoT SiteWise Asset Modeling +* (**sagemaker**) This release adds the ability for customers to attach and detach their EBS volumes to EKS-orchestrated HyperPod cluster nodes. + +## [1.5.9] - 08/01/2025 + +### Features +* (**aiops**) This release includes fix for InvestigationGroup timestamp conversion issue. +* (**arcregionswitch**) This is the initial SDK release for Region switch +* (**auditmanager**) Added a note to Framework APIs (CreateAssessmentFramework, GetAssessmentFramework, UpdateAssessmentFramework) clarifying that the Controls object returns a partial response when called through Framework APIs. Added documentation that the Framework's controlSources parameter is no longer supported. +* (**lightsail**) This release adds support for the Asia Pacific (Jakarta) (ap-southeast-3) Region. +* (**observabilityadmin**) CloudWatch Observability Admin adds the ability to enable telemetry on AWS resources such as Amazon VPCs (Flow Logs) in customers AWS Accounts and Organizations. The release introduces new APIs to manage telemetry rules, which define telemetry settings to be applied on AWS resources. +* (**pcs**) Add support for IPv6 Networking for Clusters. +* (**securityhub**) Release new resource detail type CodeRepository + +### Documentation +* (**acmpca**) Doc-only update to add more information to GetCertificate action. +* (**sns**) Amazon SNS support for Amazon SQS fair queues + +## [1.5.8] - 07/31/2025 + +### Features +* (**customerprofiles**) The release updates standard profile with 2 new fields that supports account-level engagement. Updated APIs include CreateProfile, UpdateProfile, MergeProfiles, SearchProfiles, BatchGetProfile, GetSegmentMembership, CreateSegmentDefinition, CreateSegmentEstimate. +* (**ec2**) Added support for the force option for the EC2 instance terminate command. This feature enables customers to recover resources associated with an instance stuck in the shutting-down state as a result of rare issues caused by a frozen operating system or an underlying hardware problem. +* (**entityresolution**) Add support for creating advanced rule-based matching workflows in AWS Entity Resolution. +* (**glue**) Added support for Route node, S3 Iceberg sources/targets, catalog Iceberg sources, DynamoDB ELT connector, AutoDataQuality evaluation, enhanced PII detection with redaction, Kinesis fan-out support, and new R-series worker types. +* (**inspector2**) Extend usage to include agentless hours and add CODE_REPOSITORY to aggregation resource type +* (**iot**) This release allows AWS IoT Core users to use their own AWS KMS keys for data protection +* (**opensearch**) Granular access control support for NEO-SAML with IAMFederation for AOS data source +* (**quicksight**) Added Impala connector support +* (**s3control**) Add Tags field to CreateAccessPoint +* (**sesv2**) This release introduces support for Multi-tenant management +* (**workspacesweb**) Added ability to log session activity on a portal to an S3 bucket. + +### Documentation +* (**elasticloadbalancingv2**) This release enables secondary IP addresses for Network Load Balancers. + +## [1.5.7] - 07/30/2025 + +### Features +* (**cloudfront**) This release adds new origin timeout options: 1) ResponseCompletionTimeout and 2) OriginReadTimeout (for S3 origins) +* (**directoryservice**) This release adds support for AWS Managed Microsoft AD Hybrid Edition, introducing new operations: StartADAssessment, DescribeADAssessment, ListADAssessments, DeleteADAssessment, CreateHybridAD, UpdateHybridAD, and DescribeHybridADUpdate; and updated existing operation: DescribeDirectories. +* (**docdb**) Add support for setting Serverless Scaling Configuration on clusters. +* (**ec2**) Release to show the next hop IP address for routes propagated by VPC Route Server into VPC route tables. +* (**iotwireless**) Added TxPowerIndexMin, TxPowerIndexMax, NbTransMin and NbTransMax params to ServiceProfile. + +## [1.5.6] - 07/29/2025 + +### Features +* (**batch**) AWS Batch for SageMaker Training jobs feature support. Includes new APIs for service job submission (e.g., SubmitServiceJob) and managing service environments (e.g., CreateServiceEnvironment) that enable queueing SageMaker Training jobs. +* (**cleanrooms**) This feature provides the ability to update the table reference and allowed columns on an existing configured table. +* (**deadline**) Adds support for tag management on monitors. +* (**location**) This release 1) adds support for multi-polygon geofences with disconnected territories, and 2) enables polygon exclusion zones within geofences for more accurate representation of real-world boundaries. +* (**opensearchserverless**) This is to support Granular access control support for SAML with IAMFedraton in AOSS + +## [1.5.5] - 07/28/2025 + +### Features +* (**directconnect**) Enable MACSec support and features on Interconnects. +* (**iotsitewise**) Add support for native anomaly detection in IoT SiteWise using new Computation Model APIs +* (**osis**) Add Pipeline Role Arn as an optional parameter to the create / update pipeline APIs as an alternative to passing in the pipeline configuration body + +## [1.5.4] - 07/25/2025 + +### Features +* (**appintegrations**) Amazon AppIntegrations introduces new configuration capabilities to enable customers to manage iframe permissions, control application refresh behavior (per contact or per browser/cross-contact), and run background applications (service). +* (**budgets**) Adds IPv6 and PrivateLink support for AWS Budgets in IAD. +* (**ec2**) Transit Gateway native integration with AWS Network Firewall. Adding new enum value for the new Transit Gateway Attachment type. +* (**mediapackagev2**) This release adds support for specifying a preferred input for channels using CMAF ingest. +* (**socialmessaging**) This release introduces new WhatsApp template management APIs that enable customers to programmatically create and submit templates for approval, monitor approval status, and manage the complete template lifecycle + +### Documentation +* (**configservice**) Documentation improvements have been made to the EvaluationModel and DescribeConfigurationRecorders APIs. +* (**kms**) Doc only update: fixed grammatical errors. +* (**sqs**) Documentation updates for Amazon SQS fair queues feature. + +## [1.5.3] - 07/24/2025 + +### Features +* (**datazone**) This release adds support for 1) highlighting relevant text in returned results for Search and SearchListings APIs and 2) returning aggregated counts of values for specified attributes for SearchListings API. +* (**omics**) Add Git integration and README support for HealthOmics workflows + +## [1.5.2] - 07/23/2025 + +### Features +* (**ec2**) Added support for skip-os-shutdown option for the EC2 instance stop and terminate operations. This feature enables customers to bypass the graceful OS shutdown, supporting faster state transitions when instance data preservation isn't critical. +* (**glue**) AWS Glue now supports dynamic session policies for job executions. This feature allows you to specify custom, fine-grained permissions for each job run without creating multiple IAM roles. +* (**workspacesthinclient**) Added the lastUserId parameter to the ListDevices and GetDevice API. + +## [1.5.1] - 07/22/2025 + +### Features +* (**ecr**) Add support for Image Tag Mutability Exception feature, allowing repositories to define wildcard-based patterns that override the default image tag mutability settings. +* (**emr**) This release adds new parameter 'ExtendedSupport' in AWS EMR RunJobFlow, ModifyCluster and DescribeCluster API. +* (**lambda**) This release migrated the model to Smithy keeping all features unchanged. +* (**neptunedata**) This release updates the supported regions for Neptune API to include current AWS regions. + +## [1.5.0] - 07/21/2025 + +### Features +* (**cloudfront**) Add dualstack endpoint support +* (**deadline**) Add support for VPC resource endpoints in Service Managed Fleets +* (**ec2**) This release adds support for C8gn, F2 and P6e-GB200 Instance types +* (**sagemaker**) This release adds 1/ Support for S3FileSystem in CustomFileSystems 2/ The ability for a customer to select their preferred IpAddressType for use with private Workforces 3/ Support for p4de instance type in SageMaker Training Plans +* (**timestreaminfluxdb**) Timestream for InfluxDB adds support for db.influx.24xlarge instance type. This enhancement enables higher compute capacity for demanding workloads through CreateDbInstance, CreateDbCluster, UpdateDbInstance, and UpdateDbCluster APIs. +* Upgrade to Kotlin 2.2.0 +* [#1413](https://github.com/awslabs/aws-sdk-kotlin/issues/1413) ⚠️ **IMPORTANT**: Refactor endpoint discoverer classes into interfaces so custom implementations may be provided +* [#1478](https://github.com/awslabs/aws-sdk-kotlin/issues/1478) Add `regionProvider` property to client config +* [#1413](https://github.com/awslabs/aws-sdk-kotlin/issues/1413) ⚠️ **IMPORTANT**: Add support for enabling/disabling endpoint discovery via [standard cross-SDK config mechanisms](https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoint-discovery.html) + +### Fixes +* [#1413](https://github.com/awslabs/aws-sdk-kotlin/issues/1413) Favor `endpointUrl` instead of endpoint discovery if both are provided + +## [1.4.125] - 07/18/2025 + +### Features +* (**auditmanager**) Updated error handling for RegisterOrganizationAdminAccount API to properly translate TooManyExceptions to HTTP 429 status code. This enhancement improves error handling consistency and provides clearer feedback when request limits are exceeded. +* (**cloudwatchlogs**) CloudWatchLogs launches GetLogObject API with streaming support for efficient log data retrieval. Logs added support for new AccountPolicy type METRIC_EXTRACTION_POLICY. For more information, see CloudWatch Logs API documentation +* (**mediaconvert**) This release adds support for TAMS server integration with MediaConvert inputs. +* (**outposts**) Add AWS Outposts API to surface customer billing information +* (**sesv2**) Added IP Visibility support for managed dedicated pools. Enhanced GetDedicatedIp and GetDedicatedIps APIs to return managed IP addresses. + +### Documentation +* (**ssm**) July 2025 doc-only updates for Systems Manager. + +## [1.4.124] - 07/17/2025 + +### Features +* (**cleanroomsml**) This release introduces Parquet result format support for ML Input Channel models in AWS Clean Rooms ML. +* (**ec2**) AWS Free Tier Version2 Support +* (**mailmanager**) Allow underscores in the local part of the input of the "Email recipients rewrite" action in rule sets. +* (**mediaconvert**) This release expands the range of supported audio outputs to include xHE, 192khz FLAC and the deprecation of dual mono for AC3. +* (**synthetics**) This feature allows AWS Synthetics customers to provide code dependencies using lambda layer while creating a canary + +### Documentation +* (**cloudfront**) Doc only update for CloudFront that fixes some customer-reported issues +* (**keyspacesstreams**) Doc only update for the Amazon Keyspaces Streams API. +* (**sfn**) Align input with style guidelines. + ## [1.4.123] - 07/16/2025 ### Features diff --git a/aws-runtime/aws-config/api/aws-config.api b/aws-runtime/aws-config/api/aws-config.api index eec0b5f660d..723bdc371fe 100644 --- a/aws-runtime/aws-config/api/aws-config.api +++ b/aws-runtime/aws-config/api/aws-config.api @@ -246,6 +246,27 @@ public abstract class aws/sdk/kotlin/runtime/config/AbstractAwsSdkClientFactory public static synthetic fun fromEnvironment$default (Laws/sdk/kotlin/runtime/config/AbstractAwsSdkClientFactory;Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; } +public abstract interface class aws/sdk/kotlin/runtime/config/AwsSdkClientConfig : aws/smithy/kotlin/runtime/client/SdkClientConfig { + public abstract fun getApplicationId ()Ljava/lang/String; + public abstract fun getRegion ()Ljava/lang/String; + public abstract fun getRegionProvider ()Laws/smithy/kotlin/runtime/client/region/RegionProvider; + public abstract fun getUseDualStack ()Z + public abstract fun getUseFips ()Z +} + +public abstract interface class aws/sdk/kotlin/runtime/config/AwsSdkClientConfig$Builder { + public abstract fun getApplicationId ()Ljava/lang/String; + public abstract fun getRegion ()Ljava/lang/String; + public abstract fun getRegionProvider ()Laws/smithy/kotlin/runtime/client/region/RegionProvider; + public abstract fun getUseDualStack ()Ljava/lang/Boolean; + public abstract fun getUseFips ()Ljava/lang/Boolean; + public abstract fun setApplicationId (Ljava/lang/String;)V + public abstract fun setRegion (Ljava/lang/String;)V + public abstract fun setRegionProvider (Laws/smithy/kotlin/runtime/client/region/RegionProvider;)V + public abstract fun setUseDualStack (Ljava/lang/Boolean;)V + public abstract fun setUseFips (Ljava/lang/Boolean;)V +} + public final class aws/sdk/kotlin/runtime/config/AwsSdkSetting { public static final field INSTANCE Laws/sdk/kotlin/runtime/config/AwsSdkSetting; public final fun getAwsAccessKeyId ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; @@ -263,6 +284,7 @@ public final class aws/sdk/kotlin/runtime/config/AwsSdkSetting { public final fun getAwsEc2MetadataDisabled ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; public final fun getAwsEc2MetadataServiceEndpoint ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; public final fun getAwsEc2MetadataServiceEndpointMode ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsEndpointDiscoveryEnabled ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; public final fun getAwsEndpointUrl ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; public final fun getAwsExecutionEnv ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; public final fun getAwsIgnoreEndpointUrls ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; @@ -324,6 +346,8 @@ public final class aws/sdk/kotlin/runtime/config/endpoints/ResolversKt { public static final fun resolveAccountId (Laws/sdk/kotlin/runtime/config/endpoints/AccountIdEndpointMode;Laws/smithy/kotlin/runtime/collections/Attributes;)Ljava/lang/String; public static final fun resolveAccountIdEndpointMode (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; public static synthetic fun resolveAccountIdEndpointMode$default (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; + public static final fun resolveEndpointDiscoveryEnabled (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;ZLkotlin/coroutines/Continuation;)Ljava/lang/Object; + public static synthetic fun resolveEndpointDiscoveryEnabled$default (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;ZLkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; public static final fun resolveEndpointUrl (Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Laws/smithy/kotlin/runtime/util/PlatformProvider;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; public static synthetic fun resolveEndpointUrl$default (Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Laws/smithy/kotlin/runtime/util/PlatformProvider;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; public static final fun resolveUseDualStack (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; @@ -513,8 +537,7 @@ public final class aws/sdk/kotlin/runtime/config/profile/AwsProfileKt { public static synthetic fun getBooleanOrNull$default (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Ljava/lang/Boolean; public static final fun getCredentialProcess (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String; public static final fun getDisableRequestCompression (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/Boolean; - public static final fun getEc2InstanceProfileName (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String; - public static final fun getEc2MetadataDisabled (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/Boolean; + public static final fun getEndpointDiscoveryEnabled (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/Boolean; public static final fun getEndpointUrl (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Laws/smithy/kotlin/runtime/net/url/Url; public static final fun getIgnoreEndpointUrls (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/Boolean; public static final fun getIntOrNull (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;Ljava/lang/String;Ljava/lang/String;)Ljava/lang/Integer; @@ -570,21 +593,21 @@ public final class aws/sdk/kotlin/runtime/config/useragent/ResolveUserAgentKt { public static synthetic fun resolveUserAgentAppId$default (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; } -public final class aws/sdk/kotlin/runtime/region/DefaultRegionProviderChain : aws/sdk/kotlin/runtime/region/RegionProviderChain, aws/sdk/kotlin/runtime/region/RegionProvider, java/io/Closeable { +public final class aws/sdk/kotlin/runtime/region/DefaultRegionProviderChain : aws/smithy/kotlin/runtime/client/region/RegionProviderChain, aws/smithy/kotlin/runtime/client/region/RegionProvider, java/io/Closeable { public fun ()V public fun (Laws/smithy/kotlin/runtime/util/PlatformProvider;Lkotlin/Lazy;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;)V public synthetic fun (Laws/smithy/kotlin/runtime/util/PlatformProvider;Lkotlin/Lazy;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public fun close ()V } -public final class aws/sdk/kotlin/runtime/region/EnvironmentRegionProvider : aws/sdk/kotlin/runtime/region/RegionProvider { +public final class aws/sdk/kotlin/runtime/region/EnvironmentRegionProvider : aws/smithy/kotlin/runtime/client/region/RegionProvider { public fun ()V public fun (Laws/smithy/kotlin/runtime/util/EnvironmentProvider;)V public synthetic fun (Laws/smithy/kotlin/runtime/util/EnvironmentProvider;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public fun getRegion (Lkotlin/coroutines/Continuation;)Ljava/lang/Object; } -public final class aws/sdk/kotlin/runtime/region/ImdsRegionProvider : aws/sdk/kotlin/runtime/region/RegionProvider, java/io/Closeable { +public final class aws/sdk/kotlin/runtime/region/ImdsRegionProvider : aws/smithy/kotlin/runtime/client/region/RegionProvider, java/io/Closeable { public fun ()V public fun (Lkotlin/Lazy;Laws/smithy/kotlin/runtime/util/PlatformEnvironProvider;)V public synthetic fun (Lkotlin/Lazy;Laws/smithy/kotlin/runtime/util/PlatformEnvironProvider;ILkotlin/jvm/internal/DefaultConstructorMarker;)V @@ -592,14 +615,14 @@ public final class aws/sdk/kotlin/runtime/region/ImdsRegionProvider : aws/sdk/ko public fun getRegion (Lkotlin/coroutines/Continuation;)Ljava/lang/Object; } -public final class aws/sdk/kotlin/runtime/region/JvmSystemPropRegionProvider : aws/sdk/kotlin/runtime/region/RegionProvider { +public final class aws/sdk/kotlin/runtime/region/JvmSystemPropRegionProvider : aws/smithy/kotlin/runtime/client/region/RegionProvider { public fun ()V public fun (Laws/smithy/kotlin/runtime/util/PropertyProvider;)V public synthetic fun (Laws/smithy/kotlin/runtime/util/PropertyProvider;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public fun getRegion (Lkotlin/coroutines/Continuation;)Ljava/lang/Object; } -public final class aws/sdk/kotlin/runtime/region/ProfileRegionProvider : aws/sdk/kotlin/runtime/region/RegionProvider { +public final class aws/sdk/kotlin/runtime/region/ProfileRegionProvider : aws/smithy/kotlin/runtime/client/region/RegionProvider { public fun ()V public fun (Laws/smithy/kotlin/runtime/util/LazyAsyncValue;)V public synthetic fun (Laws/smithy/kotlin/runtime/util/LazyAsyncValue;ILkotlin/jvm/internal/DefaultConstructorMarker;)V @@ -607,18 +630,6 @@ public final class aws/sdk/kotlin/runtime/region/ProfileRegionProvider : aws/sdk public fun getRegion (Lkotlin/coroutines/Continuation;)Ljava/lang/Object; } -public abstract interface class aws/sdk/kotlin/runtime/region/RegionProvider { - public abstract fun getRegion (Lkotlin/coroutines/Continuation;)Ljava/lang/Object; -} - -public class aws/sdk/kotlin/runtime/region/RegionProviderChain : aws/sdk/kotlin/runtime/region/RegionProvider { - public fun (Ljava/util/List;)V - public fun ([Laws/sdk/kotlin/runtime/region/RegionProvider;)V - protected final fun getProviders ()[Laws/sdk/kotlin/runtime/region/RegionProvider; - public fun getRegion (Lkotlin/coroutines/Continuation;)Ljava/lang/Object; - public fun toString ()Ljava/lang/String; -} - public final class aws/sdk/kotlin/runtime/region/ResolveRegionKt { public static final fun resolveRegion (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; public static synthetic fun resolveRegion$default (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/EcsCredentialsProvider.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/EcsCredentialsProvider.kt index 40e707968ac..cc2f5ccc9e5 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/EcsCredentialsProvider.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/EcsCredentialsProvider.kt @@ -87,8 +87,8 @@ public class EcsCredentialsProvider( } val op = SdkHttpOperation.build { - serializer = EcsCredentialsSerializer(authToken) - deserializer = EcsCredentialsDeserializer() + serializeWith = EcsCredentialsSerializer(authToken) + deserializeWith = EcsCredentialsDeserializer() operationName = "EcsCredentialsProvider" serviceName = "EcsContainerMetadata" execution.endpointResolver = EndpointResolver { Endpoint(url) } @@ -196,14 +196,14 @@ public class EcsCredentialsProvider( override fun toString(): String = this.simpleClassName } -private class EcsCredentialsDeserializer : HttpDeserialize { - override suspend fun deserialize(context: ExecutionContext, call: HttpCall): Credentials { +private class EcsCredentialsDeserializer : HttpDeserializer.NonStreaming { + override fun deserialize(context: ExecutionContext, call: HttpCall, payload: ByteArray?): Credentials { val response = call.response if (!response.status.isSuccess()) { - throwCredentialsResponseException(response) + throwCredentialsResponseException(response, payload) } - val payload = response.body.readAll() ?: throw CredentialsProviderException("HTTP credentials response did not contain a payload") + if (payload == null) throw CredentialsProviderException("HTTP credentials response did not contain a payload") val deserializer = JsonDeserializer(payload) val resp = deserializeJsonCredentials(deserializer) if (resp !is JsonCredentialsResponse.SessionCredentials) { @@ -221,8 +221,8 @@ private class EcsCredentialsDeserializer : HttpDeserialize { } } -private suspend fun throwCredentialsResponseException(response: HttpResponse): Nothing { - val errorResp = tryParseErrorResponse(response) +private fun throwCredentialsResponseException(response: HttpResponse, payload: ByteArray?): Nothing { + val errorResp = tryParseErrorResponse(response, payload) val messageDetails = errorResp?.run { "code=$code; message=$message" } ?: "HTTP ${response.status}" throw CredentialsProviderException("Error retrieving credentials from container service: $messageDetails").apply { @@ -233,17 +233,15 @@ private suspend fun throwCredentialsResponseException(response: HttpResponse): N } } -private suspend fun tryParseErrorResponse(response: HttpResponse): JsonCredentialsResponse.Error? { - if (response.headers["Content-Type"] != "application/json") return null - val payload = response.body.readAll() ?: return null - +private fun tryParseErrorResponse(response: HttpResponse, payload: ByteArray?): JsonCredentialsResponse.Error? { + if (response.headers["Content-Type"] != "application/json" || payload == null) return null return deserializeJsonCredentials(JsonDeserializer(payload)) as? JsonCredentialsResponse.Error } private class EcsCredentialsSerializer( private val authToken: String? = null, -) : HttpSerialize { - override suspend fun serialize(context: ExecutionContext, input: Unit): HttpRequestBuilder { +) : HttpSerializer.NonStreaming { + override fun serialize(context: ExecutionContext, input: Unit): HttpRequestBuilder { val builder = HttpRequestBuilder() builder.url.path builder.header("Accept", "application/json") diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/JsonCredentialsDeserializer.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/JsonCredentialsDeserializer.kt index 21dc4ed3b4e..51eace3bb53 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/JsonCredentialsDeserializer.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/JsonCredentialsDeserializer.kt @@ -74,7 +74,7 @@ internal sealed class JsonCredentialsResponse { * ``` */ @Suppress("ktlint:standard:property-naming") -internal suspend fun deserializeJsonCredentials(deserializer: Deserializer): JsonCredentialsResponse { +internal fun deserializeJsonCredentials(deserializer: Deserializer): JsonCredentialsResponse { val CODE_DESCRIPTOR = SdkFieldDescriptor(SerialKind.String, JsonSerialName("Code")) val ACCESS_KEY_ID_DESCRIPTOR = SdkFieldDescriptor(SerialKind.String, JsonSerialName("AccessKeyId")) val SECRET_ACCESS_KEY_ID_DESCRIPTOR = SdkFieldDescriptor(SerialKind.String, JsonSerialName("SecretAccessKey")) diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/AbstractAwsSdkClientFactory.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/AbstractAwsSdkClientFactory.kt index 2edc6dcbb88..ae6c666a45e 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/AbstractAwsSdkClientFactory.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/AbstractAwsSdkClientFactory.kt @@ -5,7 +5,6 @@ package aws.sdk.kotlin.runtime.config -import aws.sdk.kotlin.runtime.client.AwsSdkClientConfig import aws.sdk.kotlin.runtime.config.auth.resolveAuthSchemePreference import aws.sdk.kotlin.runtime.config.checksums.resolveRequestChecksumCalculation import aws.sdk.kotlin.runtime.config.checksums.resolveResponseChecksumValidation @@ -22,7 +21,10 @@ import aws.sdk.kotlin.runtime.region.resolveRegion import aws.sdk.kotlin.runtime.region.resolveSigV4aSigningRegionSet import aws.smithy.kotlin.runtime.ExperimentalApi import aws.smithy.kotlin.runtime.auth.awscredentials.SigV4aClientConfig -import aws.smithy.kotlin.runtime.client.* +import aws.smithy.kotlin.runtime.client.AbstractSdkClientFactory +import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfig +import aws.smithy.kotlin.runtime.client.SdkClient +import aws.smithy.kotlin.runtime.client.SdkClientConfig import aws.smithy.kotlin.runtime.client.config.ClientSettings import aws.smithy.kotlin.runtime.client.config.CompressionClientConfig import aws.smithy.kotlin.runtime.client.config.HttpChecksumConfig @@ -79,7 +81,7 @@ public abstract class AbstractAwsSdkClientFactory< block?.let(config::apply) config.logMode = config.logMode ?: ClientSettings.LogMode.resolve(platform = platform) - config.region = config.region ?: resolveRegion(profile = profile) + config.region = config.region ?: config.regionProvider?.getRegion() ?: resolveRegion(profile = profile) config.useFips = config.useFips ?: resolveUseFips(profile = profile) config.useDualStack = config.useDualStack ?: resolveUseDualStack(profile = profile) config.applicationId = config.applicationId ?: resolveUserAgentAppId(platform, profile) diff --git a/aws-runtime/aws-core/common/src/aws/sdk/kotlin/runtime/client/AwsSdkClientConfig.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/AwsSdkClientConfig.kt similarity index 63% rename from aws-runtime/aws-core/common/src/aws/sdk/kotlin/runtime/client/AwsSdkClientConfig.kt rename to aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/AwsSdkClientConfig.kt index b8073748e0e..37281bd716f 100644 --- a/aws-runtime/aws-core/common/src/aws/sdk/kotlin/runtime/client/AwsSdkClientConfig.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/AwsSdkClientConfig.kt @@ -3,9 +3,10 @@ * SPDX-License-Identifier: Apache-2.0 */ -package aws.sdk.kotlin.runtime.client +package aws.sdk.kotlin.runtime.config import aws.smithy.kotlin.runtime.client.SdkClientConfig +import aws.smithy.kotlin.runtime.client.region.RegionProvider /** * Base interface all generated AWS SDK Kotlin clients implement @@ -14,11 +15,27 @@ public interface AwsSdkClientConfig : SdkClientConfig { /** * The AWS region (e.g. `us-west-2`) to make requests to. See about AWS - * [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more - * information + * [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more information. + * When specified, this static region configuration takes precedence over other region resolution methods. + * + * The region resolution order is: + * 1. Static region (if specified) + * 2. Custom region provider (if configured) + * 3. Default region provider chain */ public val region: String? + /** + * An optional region provider that determines the AWS region for client operations. When specified, this provider + * takes precedence over the default region provider chain, unless a static region is explicitly configured. + * + * The region resolution order is: + * 1. Static region (if specified) + * 2. Custom region provider (if configured) + * 3. Default region provider chain + */ + public val regionProvider: RegionProvider + /** * Flag to toggle whether to use [FIPS](https://aws.amazon.com/compliance/fips/) endpoints when making requests. * Disabled by default. @@ -49,11 +66,27 @@ public interface AwsSdkClientConfig : SdkClientConfig { public interface Builder { /** * The AWS region (e.g. `us-west-2`) to make requests to. See about AWS - * [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more - * information + * [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more information. + * When specified, this static region configuration takes precedence over other region resolution methods. + * + * The region resolution order is: + * 1. Static region (if specified) + * 2. Custom region provider (if configured) + * 3. Default region provider chain */ public var region: String? + /** + * An optional region provider that determines the AWS region for client operations. When specified, this provider + * takes precedence over the default region provider chain, unless a static region is explicitly configured. + * + * The region resolution order is: + * 1. Static region (if specified) + * 2. Custom region provider (if configured) + * 3. Default region provider chain + */ + public var regionProvider: RegionProvider? + /** * Flag to toggle whether to use [FIPS](https://aws.amazon.com/compliance/fips/) endpoints when making requests. * Disabled by default. diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/AwsSdkSetting.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/AwsSdkSetting.kt index 2f86a889006..dd8a0240058 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/AwsSdkSetting.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/AwsSdkSetting.kt @@ -219,6 +219,15 @@ public object AwsSdkSetting { public val AwsSigV4aSigningRegionSet: EnvironmentSetting = strEnvSetting("aws.sigV4aSigningRegionSet", "AWS_SIGV4A_SIGNING_REGION_SET") + /** + * A flag indicating whether endpoint discovery is enabled for AWS services that support it. The implicit default + * value for this setting is: + * * `true` for services which _require_ EP discovery (e.g., Timestream) + * * `false` for services which _allow but do not require_ EP discovery (e.g., DynamoDB) + */ + public val AwsEndpointDiscoveryEnabled: EnvironmentSetting = + boolEnvSetting("aws.endpointDiscoveryEnabled", "AWS_ENABLE_ENDPOINT_DISCOVERY") + /** * Configures request checksum calculation */ diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/endpoints/Resolvers.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/endpoints/Resolvers.kt index 20bc6e974eb..590eb8ca3d7 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/endpoints/Resolvers.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/endpoints/Resolvers.kt @@ -101,3 +101,16 @@ public fun resolveAccountId(endpointMode: AccountIdEndpointMode, attributes: Att AccountIdEndpointMode.DISABLED -> null AccountIdEndpointMode.REQUIRED -> attributes.getOrNull(AwsClientOption.AccountId) ?: throw ConfigurationException("AccountIdEndpointMode is set to required but no AWS account ID found") } + +/** + * Resolve the endpoint discovery mode + */ +@InternalSdkApi +public suspend fun resolveEndpointDiscoveryEnabled( + provider: PlatformProvider = PlatformProvider.System, + profile: LazyAsyncValue = asyncLazy { loadAwsSharedConfig(provider).activeProfile }, + serviceRequiresEpDiscovery: Boolean, +): Boolean = + AwsSdkSetting.AwsEndpointDiscoveryEnabled.resolve(provider) + ?: profile.get().endpointDiscoveryEnabled + ?: serviceRequiresEpDiscovery diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/imds/ImdsClient.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/imds/ImdsClient.kt index 58b9126930e..ac4cbf9549b 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/imds/ImdsClient.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/imds/ImdsClient.kt @@ -12,10 +12,13 @@ import aws.sdk.kotlin.runtime.http.middleware.UserAgent import aws.smithy.kotlin.runtime.client.LogMode import aws.smithy.kotlin.runtime.client.SdkClientOption import aws.smithy.kotlin.runtime.client.endpoints.Endpoint -import aws.smithy.kotlin.runtime.http.* +import aws.smithy.kotlin.runtime.http.HttpCall +import aws.smithy.kotlin.runtime.http.HttpStatusCode +import aws.smithy.kotlin.runtime.http.SdkHttpClient import aws.smithy.kotlin.runtime.http.engine.DefaultHttpEngine import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine import aws.smithy.kotlin.runtime.http.engine.ProxySelector +import aws.smithy.kotlin.runtime.http.isSuccess import aws.smithy.kotlin.runtime.http.operation.* import aws.smithy.kotlin.runtime.io.Closeable import aws.smithy.kotlin.runtime.io.closeIfCloseable @@ -109,13 +112,12 @@ public class ImdsClient private constructor(builder: Builder) : InstanceMetadata */ public override suspend fun get(path: String): String { val op = SdkHttpOperation.build { - serializer = UnitSerializer - deserializer = object : HttpDeserialize { - override suspend fun deserialize(context: ExecutionContext, call: HttpCall): String { + serializeWith = HttpSerializer.Unit + deserializeWith = object : HttpDeserializer.NonStreaming { + override fun deserialize(context: ExecutionContext, call: HttpCall, payload: ByteArray?): String { val response = call.response if (response.status.isSuccess()) { - val payload = response.body.readAll() ?: throw EC2MetadataError(response.status, "no metadata payload") - return payload.decodeToString() + return payload!!.decodeToString() } else { throw EC2MetadataError(response.status, "error retrieving instance metadata: ${response.status.description}") } @@ -232,9 +234,9 @@ public enum class EndpointMode(internal val defaultEndpoint: Endpoint) { * @param message The error message */ public class EC2MetadataError(public val status: HttpStatusCode, message: String) : AwsServiceException(message) { - @Deprecated("This constructor passes HTTP status as an Int instead of as HttpStatusCode") + @Deprecated("This constructor passes HTTP status as an Int instead of as HttpStatusCode. This declaration will be removed in version 1.6.x.") public constructor(statusCode: Int, message: String) : this(HttpStatusCode.fromValue(statusCode), message) - @Deprecated("This property is now deprecated and should be fetched from status.value") + @Deprecated("This property is now deprecated and should be fetched from status.value. This declaration will be removed in version 1.6.x.") public val statusCode: Int = status.value } diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/imds/ImdsResolvers.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/imds/ImdsResolvers.kt index 52a30fbad09..89c7d8c4729 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/imds/ImdsResolvers.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/imds/ImdsResolvers.kt @@ -3,8 +3,6 @@ package aws.sdk.kotlin.runtime.config.imds import aws.sdk.kotlin.runtime.InternalSdkApi import aws.sdk.kotlin.runtime.config.AwsSdkSetting import aws.sdk.kotlin.runtime.config.profile.AwsProfile -import aws.sdk.kotlin.runtime.config.profile.ec2InstanceProfileName -import aws.sdk.kotlin.runtime.config.profile.ec2MetadataDisabled import aws.sdk.kotlin.runtime.config.profile.loadAwsSharedConfig import aws.smithy.kotlin.runtime.config.resolve import aws.smithy.kotlin.runtime.util.LazyAsyncValue @@ -18,7 +16,7 @@ import aws.smithy.kotlin.runtime.util.asyncLazy public suspend fun resolveEc2InstanceProfileName( provider: PlatformProvider = PlatformProvider.System, profile: LazyAsyncValue = asyncLazy { loadAwsSharedConfig(provider).activeProfile }, -): String? = AwsSdkSetting.AwsEc2InstanceProfileName.resolve(provider) ?: profile.get().ec2InstanceProfileName +): String? = AwsSdkSetting.AwsEc2InstanceProfileName.resolve(provider) /** * Attempts to resolve the flag which disables the use of IMDS for credentials @@ -26,4 +24,4 @@ public suspend fun resolveEc2InstanceProfileName( public suspend fun resolveDisableEc2Metadata( provider: PlatformProvider = PlatformProvider.System, profile: LazyAsyncValue = asyncLazy { loadAwsSharedConfig(provider).activeProfile }, -): Boolean? = AwsSdkSetting.AwsEc2MetadataDisabled.resolve(provider) ?: profile.get().ec2MetadataDisabled +): Boolean? = AwsSdkSetting.AwsEc2MetadataDisabled.resolve(provider) diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/profile/AwsProfile.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/profile/AwsProfile.kt index cda2bc11deb..3ec07b3a795 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/profile/AwsProfile.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/profile/AwsProfile.kt @@ -156,6 +156,14 @@ public val AwsProfile.requestMinCompressionSizeBytes: Long? public val AwsProfile.sigV4aSigningRegionSet: String? get() = getOrNull("sigv4a_signing_region_set") +/** + * A flag indicating whether endpoint discovery should be enabled for a service that supports it. This setting has no + * effect for services which _do not_ support endpoint discovery. + */ +@InternalSdkApi +public val AwsProfile.endpointDiscoveryEnabled: Boolean? + get() = getBooleanOrNull("endpoint_discovery_enabled") + /** * Configures request checksum calculation */ @@ -177,20 +185,6 @@ public val AwsProfile.responseChecksumValidation: ResponseHttpChecksumConfig? public val AwsProfile.authSchemePreference: String? get() = getOrNull("auth_scheme_preference") -/** - * Specifies a named EC2 instance profile to use which allows bypassing auto-discovery - */ -@InternalSdkApi -public val AwsProfile.ec2InstanceProfileName: String? - get() = getOrNull("ec2_instance_profile_name") - -/** - * The flag which disables the use of IMDS for credentials - */ -@InternalSdkApi -public val AwsProfile.ec2MetadataDisabled: Boolean? - get() = getBooleanOrNull("disable_ec2_metadata") - /** * Parse a config value as a boolean, ignoring case. */ diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChain.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChain.kt index 25d59284b6c..5ac84815606 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChain.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChain.kt @@ -9,6 +9,7 @@ import aws.sdk.kotlin.runtime.config.imds.ImdsClient import aws.sdk.kotlin.runtime.config.imds.InstanceMetadataProvider import aws.sdk.kotlin.runtime.config.profile.AwsProfile import aws.sdk.kotlin.runtime.config.profile.loadAwsSharedConfig +import aws.smithy.kotlin.runtime.client.region.RegionProvider import aws.smithy.kotlin.runtime.io.Closeable import aws.smithy.kotlin.runtime.util.LazyAsyncValue import aws.smithy.kotlin.runtime.util.PlatformProvider diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/EnvironmentRegionProvider.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/EnvironmentRegionProvider.kt index c1058296510..126083ebf4e 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/EnvironmentRegionProvider.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/EnvironmentRegionProvider.kt @@ -6,6 +6,7 @@ package aws.sdk.kotlin.runtime.region import aws.sdk.kotlin.runtime.config.AwsSdkSetting +import aws.smithy.kotlin.runtime.client.region.RegionProvider import aws.smithy.kotlin.runtime.util.EnvironmentProvider import aws.smithy.kotlin.runtime.util.PlatformProvider diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/ImdsRegionProvider.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/ImdsRegionProvider.kt index 6b488006617..9191b9957df 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/ImdsRegionProvider.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/ImdsRegionProvider.kt @@ -8,6 +8,7 @@ package aws.sdk.kotlin.runtime.region import aws.sdk.kotlin.runtime.config.AwsSdkSetting import aws.sdk.kotlin.runtime.config.imds.ImdsClient import aws.sdk.kotlin.runtime.config.imds.InstanceMetadataProvider +import aws.smithy.kotlin.runtime.client.region.RegionProvider import aws.smithy.kotlin.runtime.config.resolve import aws.smithy.kotlin.runtime.io.Closeable import aws.smithy.kotlin.runtime.util.PlatformEnvironProvider diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/ProfileRegionProvider.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/ProfileRegionProvider.kt index 9e50d845d7b..c1b4491354b 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/ProfileRegionProvider.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/ProfileRegionProvider.kt @@ -8,6 +8,7 @@ package aws.sdk.kotlin.runtime.region import aws.sdk.kotlin.runtime.config.profile.AwsProfile import aws.sdk.kotlin.runtime.config.profile.loadAwsSharedConfig import aws.sdk.kotlin.runtime.config.profile.region +import aws.smithy.kotlin.runtime.client.region.RegionProvider import aws.smithy.kotlin.runtime.util.LazyAsyncValue import aws.smithy.kotlin.runtime.util.PlatformProvider import aws.smithy.kotlin.runtime.util.asyncLazy diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/RegionProvider.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/RegionProvider.kt deleted file mode 100644 index 63105bdf3c9..00000000000 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/RegionProvider.kt +++ /dev/null @@ -1,17 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * SPDX-License-Identifier: Apache-2.0 - */ - -package aws.sdk.kotlin.runtime.region - -/** - * Interface for providing AWS region information. Implementations are free to use any strategy for - * providing region information - */ -public interface RegionProvider { - /** - * Return the region name to use. If region information is not available, implementations should return null - */ - public suspend fun getRegion(): String? -} diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/RegionProviderChain.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/RegionProviderChain.kt deleted file mode 100644 index 4f7c4ce3012..00000000000 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/RegionProviderChain.kt +++ /dev/null @@ -1,52 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * SPDX-License-Identifier: Apache-2.0 - */ - -package aws.sdk.kotlin.runtime.region - -import aws.smithy.kotlin.runtime.telemetry.logging.logger -import aws.smithy.kotlin.runtime.util.asyncLazy -import kotlin.coroutines.coroutineContext - -/** - * Composite [RegionProvider] that delegates to a chain of providers. - * [providers] are consulted in the order given and the first region found is returned - * - * @param providers the list of providers to delegate to - */ -public open class RegionProviderChain( - protected vararg val providers: RegionProvider, -) : RegionProvider { - - public constructor(providers: List) : this(*providers.toTypedArray()) - - private val resolvedRegion = asyncLazy(::resolveRegion) - - init { - require(providers.isNotEmpty()) { "at least one provider must be in the chain" } - } - - override fun toString(): String = - (listOf(this) + providers).map { it::class.simpleName }.joinToString(" -> ") - - override suspend fun getRegion(): String? = resolvedRegion.get() - - private suspend fun resolveRegion(): String? { - val logger = coroutineContext.logger() - for (provider in providers) { - try { - val region = provider.getRegion() - if (region != null) { - logger.debug { "resolved region ($region) from $provider " } - return region - } - logger.debug { "failed to resolve region from $provider" } - } catch (ex: Exception) { - logger.debug { "unable to load region from $provider: ${ex.message}" } - } - } - - return null - } -} diff --git a/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/config/endpoints/ResolveEndpointDiscoveryTest.kt b/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/config/endpoints/ResolveEndpointDiscoveryTest.kt new file mode 100644 index 00000000000..f54a4e54691 --- /dev/null +++ b/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/config/endpoints/ResolveEndpointDiscoveryTest.kt @@ -0,0 +1,77 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ +package aws.sdk.kotlin.runtime.config.endpoints + +import aws.sdk.kotlin.runtime.config.profile.* +import aws.sdk.kotlin.runtime.config.profile.FileType +import aws.sdk.kotlin.runtime.config.profile.parse +import aws.sdk.kotlin.runtime.config.profile.toSharedConfig +import aws.smithy.kotlin.runtime.telemetry.logging.Logger +import aws.smithy.kotlin.runtime.util.TestPlatformProvider +import aws.smithy.kotlin.runtime.util.asyncLazy +import kotlinx.coroutines.test.runTest +import kotlin.test.Test +import kotlin.test.assertEquals + +class ResolveEndpointDiscoveryTest { + @Test + fun testPrecedenceSysProps() = assertEpDiscovery( + sysProps = mapOf("aws.endpointDiscoveryEnabled" to "true"), + env = mapOf("AWS_ENABLE_ENDPOINT_DISCOVERY" to "false"), + config = """ + [${Literals.DEFAULT_PROFILE}] + endpoint_discovery_enabled = false + """.trimIndent(), + serviceRequiresEpDiscovery = false, + expected = true, + ) + + @Test + fun testPrecedenceEnvVars() = assertEpDiscovery( + env = mapOf("AWS_ENABLE_ENDPOINT_DISCOVERY" to "true"), + config = """ + [${Literals.DEFAULT_PROFILE}] + endpoint_discovery_enabled = false + """.trimIndent(), + serviceRequiresEpDiscovery = false, + expected = true, + ) + + @Test + fun testPrecedenceConfig() = assertEpDiscovery( + config = """ + [${Literals.DEFAULT_PROFILE}] + endpoint_discovery_enabled = true + """.trimIndent(), + serviceRequiresEpDiscovery = false, + expected = true, + ) + + @Test + fun testPrecedenceDefault() = assertEpDiscovery( + serviceRequiresEpDiscovery = true, + expected = true, + ) +} + +fun assertEpDiscovery( + sysProps: Map = mapOf(), + env: Map = mapOf(), + config: String = "", + serviceRequiresEpDiscovery: Boolean, + expected: Boolean, +) = runTest { + val provider = TestPlatformProvider(env, sysProps) + val source = AwsConfigurationSource(Literals.DEFAULT_PROFILE, "", "") + + val profile = asyncLazy { + parse(Logger.None, FileType.CONFIGURATION, config) + .toSharedConfig(source) + .activeProfile + } + + val actual = resolveEndpointDiscoveryEnabled(provider, profile, serviceRequiresEpDiscovery) + assertEquals(expected, actual) +} diff --git a/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/region/AwsRegionProviderChainTest.kt b/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/region/AwsRegionProviderChainTest.kt deleted file mode 100644 index 495e715184f..00000000000 --- a/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/region/AwsRegionProviderChainTest.kt +++ /dev/null @@ -1,47 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * SPDX-License-Identifier: Apache-2.0 - */ - -package aws.sdk.kotlin.runtime.region - -import kotlinx.coroutines.test.runTest -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertFails - -class AwsRegionProviderChainTest { - @Test - fun testNoProviders() { - assertFails("at least one provider") { - RegionProviderChain() - } - } - data class TestProvider(val region: String? = null) : RegionProvider { - override suspend fun getRegion(): String? = region - } - - @Test - fun testChain() = runTest { - val chain = RegionProviderChain( - TestProvider(null), - TestProvider("us-east-1"), - TestProvider("us-east-2"), - ) - - assertEquals("us-east-1", chain.getRegion()) - } - - @Test - fun testChainList() = runTest { - val providers = listOf( - TestProvider(null), - TestProvider("us-east-1"), - TestProvider("us-east-2"), - ) - - val chain = RegionProviderChain(providers) - - assertEquals("us-east-1", chain.getRegion()) - } -} diff --git a/aws-runtime/aws-config/jvm/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChainJVM.kt b/aws-runtime/aws-config/jvm/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChainJVM.kt index b581deb1d18..1e5a0922e9a 100644 --- a/aws-runtime/aws-config/jvm/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChainJVM.kt +++ b/aws-runtime/aws-config/jvm/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChainJVM.kt @@ -7,6 +7,8 @@ package aws.sdk.kotlin.runtime.region import aws.sdk.kotlin.runtime.config.imds.InstanceMetadataProvider import aws.sdk.kotlin.runtime.config.profile.AwsProfile +import aws.smithy.kotlin.runtime.client.region.RegionProvider +import aws.smithy.kotlin.runtime.client.region.RegionProviderChain import aws.smithy.kotlin.runtime.io.Closeable import aws.smithy.kotlin.runtime.util.LazyAsyncValue import aws.smithy.kotlin.runtime.util.PlatformProvider diff --git a/aws-runtime/aws-config/jvm/src/aws/sdk/kotlin/runtime/region/JvmSystemPropRegionProvider.kt b/aws-runtime/aws-config/jvm/src/aws/sdk/kotlin/runtime/region/JvmSystemPropRegionProvider.kt index e2be63a151a..e992035cca5 100644 --- a/aws-runtime/aws-config/jvm/src/aws/sdk/kotlin/runtime/region/JvmSystemPropRegionProvider.kt +++ b/aws-runtime/aws-config/jvm/src/aws/sdk/kotlin/runtime/region/JvmSystemPropRegionProvider.kt @@ -6,6 +6,7 @@ package aws.sdk.kotlin.runtime.region import aws.sdk.kotlin.runtime.config.AwsSdkSetting +import aws.smithy.kotlin.runtime.client.region.RegionProvider import aws.smithy.kotlin.runtime.util.PlatformProvider import aws.smithy.kotlin.runtime.util.PropertyProvider diff --git a/aws-runtime/aws-config/jvm/test/aws/sdk/kotlin/runtime/config/AbstractAwsSdkClientFactoryTest.kt b/aws-runtime/aws-config/jvm/test/aws/sdk/kotlin/runtime/config/AbstractAwsSdkClientFactoryTest.kt index b5df492e23f..69a3e491acb 100644 --- a/aws-runtime/aws-config/jvm/test/aws/sdk/kotlin/runtime/config/AbstractAwsSdkClientFactoryTest.kt +++ b/aws-runtime/aws-config/jvm/test/aws/sdk/kotlin/runtime/config/AbstractAwsSdkClientFactoryTest.kt @@ -5,11 +5,12 @@ package aws.sdk.kotlin.runtime.config -import aws.sdk.kotlin.runtime.client.AwsSdkClientConfig import aws.sdk.kotlin.runtime.config.profile.loadAwsSharedConfig import aws.sdk.kotlin.runtime.config.useragent.resolveUserAgentAppId import aws.sdk.kotlin.runtime.config.utils.mockPlatform +import aws.sdk.kotlin.runtime.region.DefaultRegionProviderChain import aws.smithy.kotlin.runtime.client.* +import aws.smithy.kotlin.runtime.client.region.RegionProvider import aws.smithy.kotlin.runtime.retries.StandardRetryStrategy import aws.smithy.kotlin.runtime.util.PlatformProvider import aws.smithy.kotlin.runtime.util.asyncLazy @@ -129,6 +130,7 @@ private interface TestClient : SdkClient { override val clientName: String = builder.clientName override val logMode: LogMode = builder.logMode ?: LogMode.Default override val region: String? = builder.region + override var regionProvider: RegionProvider = builder.regionProvider ?: DefaultRegionProviderChain() override var useFips: Boolean = builder.useFips ?: false override var useDualStack: Boolean = builder.useDualStack ?: false override val applicationId: String? = builder.applicationId @@ -141,6 +143,7 @@ private interface TestClient : SdkClient { override var clientName: String = "Test" override var logMode: LogMode? = LogMode.Default override var region: String? = null + override var regionProvider: RegionProvider? = null override var useFips: Boolean? = null override var useDualStack: Boolean? = null override var applicationId: String? = null diff --git a/aws-runtime/aws-config/native/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChainNative.kt b/aws-runtime/aws-config/native/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChainNative.kt index 6dc090d4203..85cc27aacea 100644 --- a/aws-runtime/aws-config/native/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChainNative.kt +++ b/aws-runtime/aws-config/native/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChainNative.kt @@ -7,6 +7,7 @@ package aws.sdk.kotlin.runtime.region import aws.sdk.kotlin.runtime.config.imds.InstanceMetadataProvider import aws.sdk.kotlin.runtime.config.profile.AwsProfile +import aws.smithy.kotlin.runtime.client.region.RegionProvider import aws.smithy.kotlin.runtime.io.Closeable import aws.smithy.kotlin.runtime.util.LazyAsyncValue import aws.smithy.kotlin.runtime.util.PlatformProvider diff --git a/aws-runtime/aws-core/api/aws-core.api b/aws-runtime/aws-core/api/aws-core.api index 612389b04ac..406106edd66 100644 --- a/aws-runtime/aws-core/api/aws-core.api +++ b/aws-runtime/aws-core/api/aws-core.api @@ -35,21 +35,3 @@ public final class aws/sdk/kotlin/runtime/client/AwsClientOption { public final fun getRegion ()Laws/smithy/kotlin/runtime/collections/AttributeKey; } -public abstract interface class aws/sdk/kotlin/runtime/client/AwsSdkClientConfig : aws/smithy/kotlin/runtime/client/SdkClientConfig { - public abstract fun getApplicationId ()Ljava/lang/String; - public abstract fun getRegion ()Ljava/lang/String; - public abstract fun getUseDualStack ()Z - public abstract fun getUseFips ()Z -} - -public abstract interface class aws/sdk/kotlin/runtime/client/AwsSdkClientConfig$Builder { - public abstract fun getApplicationId ()Ljava/lang/String; - public abstract fun getRegion ()Ljava/lang/String; - public abstract fun getUseDualStack ()Ljava/lang/Boolean; - public abstract fun getUseFips ()Ljava/lang/Boolean; - public abstract fun setApplicationId (Ljava/lang/String;)V - public abstract fun setRegion (Ljava/lang/String;)V - public abstract fun setUseDualStack (Ljava/lang/Boolean;)V - public abstract fun setUseFips (Ljava/lang/Boolean;)V -} - diff --git a/aws-runtime/aws-endpoint/api/aws-endpoint.api b/aws-runtime/aws-endpoint/api/aws-endpoint.api index 422fd99f426..5920133c895 100644 --- a/aws-runtime/aws-endpoint/api/aws-endpoint.api +++ b/aws-runtime/aws-endpoint/api/aws-endpoint.api @@ -42,12 +42,6 @@ public final class aws/sdk/kotlin/runtime/endpoint/functions/Partition { public final class aws/sdk/kotlin/runtime/endpoint/functions/PartitionConfig { public fun ()V - public fun (Ljava/lang/String;)V - public fun (Ljava/lang/String;Ljava/lang/String;)V - public fun (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V - public fun (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Boolean;)V - public fun (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;)V - public synthetic fun (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public fun (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/String;)V public synthetic fun (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public final fun component1 ()Ljava/lang/String; diff --git a/aws-runtime/aws-endpoint/common/src/aws/sdk/kotlin/runtime/endpoint/functions/Functions.kt b/aws-runtime/aws-endpoint/common/src/aws/sdk/kotlin/runtime/endpoint/functions/Functions.kt index c59fc81c891..6493cc1d4d1 100644 --- a/aws-runtime/aws-endpoint/common/src/aws/sdk/kotlin/runtime/endpoint/functions/Functions.kt +++ b/aws-runtime/aws-endpoint/common/src/aws/sdk/kotlin/runtime/endpoint/functions/Functions.kt @@ -9,7 +9,6 @@ import aws.sdk.kotlin.runtime.InternalSdkApi import aws.smithy.kotlin.runtime.client.endpoints.functions.isValidHostLabel import aws.smithy.kotlin.runtime.net.isIpv4 import aws.smithy.kotlin.runtime.net.isIpv6 -import kotlin.jvm.JvmOverloads // the number of top-level components an arn contains (separated by colons) private const val ARN_COMPONENT_COUNT = 6 @@ -70,23 +69,6 @@ public data class PartitionConfig( public val supportsDualStack: Boolean? = null, public val implicitGlobalRegion: String? = null, ) { - @Deprecated("This constructor does not support implicitGlobalRegion") // but is added for backwards compatibility - @JvmOverloads - public constructor ( - name: String? = null, - dnsSuffix: String? = null, - dualStackDnsSuffix: String? = null, - supportsFIPS: Boolean? = null, - supportsDualStack: Boolean? = null, - ) : this( - name, - dnsSuffix, - dualStackDnsSuffix, - supportsFIPS, - supportsDualStack, - null, - ) - public fun mergeWith(other: PartitionConfig): PartitionConfig = PartitionConfig( other.name ?: name, diff --git a/aws-runtime/aws-http/api/aws-http.api b/aws-runtime/aws-http/api/aws-http.api index 1b6ced4a550..fea5bdc046c 100644 --- a/aws-runtime/aws-http/api/aws-http.api +++ b/aws-runtime/aws-http/api/aws-http.api @@ -168,29 +168,6 @@ public final class aws/sdk/kotlin/runtime/http/interceptors/IgnoreCompositeFlexi public fun ignoreChecksum (Ljava/lang/String;Laws/smithy/kotlin/runtime/client/ProtocolResponseInterceptorContext;)Z } -public final class aws/sdk/kotlin/runtime/http/interceptors/UnsupportedSigningAlgorithmInterceptor : aws/smithy/kotlin/runtime/client/Interceptor { - public fun ()V - public fun modifyBeforeAttemptCompletion-gIAlu-s (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; - public fun modifyBeforeCompletion-gIAlu-s (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; - public fun modifyBeforeDeserialization (Laws/smithy/kotlin/runtime/client/ProtocolResponseInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; - public fun modifyBeforeRetryLoop (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; - public fun modifyBeforeSerialization (Laws/smithy/kotlin/runtime/client/RequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; - public fun modifyBeforeSigning (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; - public fun modifyBeforeTransmit (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; - public fun readAfterAttempt (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;)V - public fun readAfterDeserialization (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;)V - public fun readAfterExecution (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;)V - public fun readAfterSerialization (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V - public fun readAfterSigning (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V - public fun readAfterTransmit (Laws/smithy/kotlin/runtime/client/ProtocolResponseInterceptorContext;)V - public fun readBeforeAttempt (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V - public fun readBeforeDeserialization (Laws/smithy/kotlin/runtime/client/ProtocolResponseInterceptorContext;)V - public fun readBeforeExecution (Laws/smithy/kotlin/runtime/client/RequestInterceptorContext;)V - public fun readBeforeSerialization (Laws/smithy/kotlin/runtime/client/RequestInterceptorContext;)V - public fun readBeforeSigning (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V - public fun readBeforeTransmit (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V -} - public final class aws/sdk/kotlin/runtime/http/interceptors/businessmetrics/AwsBusinessMetric : java/lang/Enum, aws/smithy/kotlin/runtime/businessmetrics/BusinessMetric { public static final field DDB_MAPPER Laws/sdk/kotlin/runtime/http/interceptors/businessmetrics/AwsBusinessMetric; public static final field S3_EXPRESS_BUCKET Laws/sdk/kotlin/runtime/http/interceptors/businessmetrics/AwsBusinessMetric; diff --git a/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/interceptors/UnsupportedSigningAlgorithmInterceptor.kt b/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/interceptors/UnsupportedSigningAlgorithmInterceptor.kt deleted file mode 100644 index d1e70eb706f..00000000000 --- a/aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/interceptors/UnsupportedSigningAlgorithmInterceptor.kt +++ /dev/null @@ -1,37 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * SPDX-License-Identifier: Apache-2.0 - */ -package aws.sdk.kotlin.runtime.http.interceptors - -import aws.sdk.kotlin.runtime.InternalSdkApi -import aws.smithy.kotlin.runtime.auth.awssigning.AwsSigningAlgorithm -import aws.smithy.kotlin.runtime.auth.awssigning.UnsupportedSigningAlgorithmException -import aws.smithy.kotlin.runtime.client.ResponseInterceptorContext -import aws.smithy.kotlin.runtime.http.interceptors.HttpInterceptor -import aws.smithy.kotlin.runtime.http.request.HttpRequest -import aws.smithy.kotlin.runtime.http.response.HttpResponse - -// FIXME: Remove this once sigV4a is supported by default AWS signer -/** - * Looks for an unsupported signing algorithm error caused by sigV4a. - * If so it sends users to a section in the AWS SDK for Kotlin documentation on how to fix it. - */ -@InternalSdkApi -@Deprecated("This interceptor is no longer used. It will be removed in the next minor version, v1.5.x.") -public class UnsupportedSigningAlgorithmInterceptor : HttpInterceptor { - override suspend fun modifyBeforeCompletion(context: ResponseInterceptorContext): Result { - context.response.exceptionOrNull()?.let { - if (it is UnsupportedSigningAlgorithmException && it.signingAlgorithm == AwsSigningAlgorithm.SIGV4_ASYMMETRIC) { - return Result.failure( - UnsupportedSigningAlgorithmException( - "SIGV4A support is not yet implemented for the default signer. For more information on how to enable it with the CRT signer, please refer to: https://a.co/3sf8533", - it.signingAlgorithm, - it, - ), - ) - } - } - return super.modifyBeforeCompletion(context) - } -} diff --git a/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/interceptors/UnsupportedSigningAlgorithmInterceptorTest.kt b/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/interceptors/UnsupportedSigningAlgorithmInterceptorTest.kt deleted file mode 100644 index d1034d48c29..00000000000 --- a/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/interceptors/UnsupportedSigningAlgorithmInterceptorTest.kt +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * SPDX-License-Identifier: Apache-2.0 - */ -package aws.sdk.kotlin.runtime.http.interceptors - -import aws.smithy.kotlin.runtime.auth.awssigning.AwsSigningAlgorithm -import aws.smithy.kotlin.runtime.auth.awssigning.UnsupportedSigningAlgorithmException -import aws.smithy.kotlin.runtime.client.ResponseInterceptorContext -import aws.smithy.kotlin.runtime.client.SdkClientOption -import aws.smithy.kotlin.runtime.http.request.HttpRequest -import aws.smithy.kotlin.runtime.http.response.HttpResponse -import aws.smithy.kotlin.runtime.operation.ExecutionContext -import kotlinx.coroutines.test.runTest -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertIs -import kotlin.test.assertTrue - -class UnsupportedSigningAlgorithmInterceptorTest { - @Test - fun testUnsupportedSigningAlgorithmSigV4a() = runTest { - val result = - UnsupportedSigningAlgorithmInterceptor() - .modifyBeforeCompletion( - context( - Result.failure( - UnsupportedSigningAlgorithmException( - "SIGV4A support is not yet implemented for the default signer.", - AwsSigningAlgorithm.SIGV4_ASYMMETRIC, - ), - ), - ), - ) - - val exception = result.exceptionOrNull() - - assertTrue(result.isFailure) - assertIs(exception) - assertEquals(exception.signingAlgorithm, AwsSigningAlgorithm.SIGV4_ASYMMETRIC) - assertEquals( - "SIGV4A support is not yet implemented for the default signer. For more information on how to enable it with the CRT signer, please refer to: https://a.co/3sf8533", - exception.message, - ) - } - - @Test - fun testUnsupportedSigningAlgorithmNotSigV4a() = runTest { - val result = - UnsupportedSigningAlgorithmInterceptor() - .modifyBeforeCompletion( - context( - Result.failure( - UnsupportedSigningAlgorithmException( - "SIGV4 support is not yet implemented for the default signer.", - AwsSigningAlgorithm.SIGV4, - ), - ), - ), - ) - - val exception = result.exceptionOrNull() - - assertTrue(result.isFailure) - assertIs(exception) - assertEquals(exception.signingAlgorithm, AwsSigningAlgorithm.SIGV4) - assertEquals("SIGV4 support is not yet implemented for the default signer.", exception.message) - } -} - -private fun context(response: Result) = - object : ResponseInterceptorContext { - override val executionContext = ExecutionContext.build { attributes[SdkClientOption.OperationName] = "test" } - override val request = Unit - override val response = response - override val protocolRequest = HttpRequest { } - override val protocolResponse = null - } diff --git a/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/middleware/AwsRetryHeaderMiddlewareTest.kt b/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/middleware/AwsRetryHeaderMiddlewareTest.kt index d07108a70cf..c34c9e682b0 100644 --- a/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/middleware/AwsRetryHeaderMiddlewareTest.kt +++ b/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/middleware/AwsRetryHeaderMiddlewareTest.kt @@ -21,8 +21,8 @@ class AwsRetryHeaderMiddlewareTest { fun testItSetsRetryHeaders() = runTest { // see retry-header SEP val op = SdkHttpOperation.build { - serializer = UnitSerializer - deserializer = UnitDeserializer + serializeWith = HttpSerializer.Unit + deserializeWith = HttpDeserializer.Unit operationName = "TestOperation" serviceName = "TestService" } diff --git a/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/middleware/RecursionDetectionTest.kt b/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/middleware/RecursionDetectionTest.kt index bc957564efa..29a81c62cbb 100644 --- a/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/middleware/RecursionDetectionTest.kt +++ b/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/middleware/RecursionDetectionTest.kt @@ -21,8 +21,8 @@ import kotlin.test.assertFalse class RecursionDetectionTest { private class TraceHeaderSerializer( private val traceHeader: String, - ) : HttpSerialize { - override suspend fun serialize(context: ExecutionContext, input: Unit): HttpRequestBuilder { + ) : HttpSerializer.NonStreaming { + override fun serialize(context: ExecutionContext, input: Unit): HttpRequestBuilder { val builder = HttpRequestBuilder() builder.headers[HEADER_TRACE_ID] = traceHeader return builder @@ -37,8 +37,13 @@ class RecursionDetectionTest { expectedTraceHeader: String?, ) { val op = SdkHttpOperation.build { - serializer = if (existingTraceHeader != null) TraceHeaderSerializer(existingTraceHeader) else UnitSerializer - deserializer = IdentityDeserializer + serializeWith = if (existingTraceHeader != null) { + TraceHeaderSerializer(existingTraceHeader) + } else { + HttpSerializer.Unit + } + + deserializeWith = HttpDeserializer.Identity operationName = "testOperation" serviceName = "TestService" } diff --git a/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/middleware/UserAgentTest.kt b/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/middleware/UserAgentTest.kt index a2fcd4259cd..332a5ee3d8d 100644 --- a/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/middleware/UserAgentTest.kt +++ b/aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/middleware/UserAgentTest.kt @@ -27,8 +27,8 @@ class UserAgentTest { private fun initializeOp(platformProvider: PlatformProvider = TestPlatformProvider()) = SdkHttpOperation.build { - serializer = UnitSerializer - deserializer = IdentityDeserializer + serializeWith = HttpSerializer.Unit + deserializeWith = HttpDeserializer.Identity operationName = "testOperation" serviceName = "TestService" }.apply { diff --git a/aws-runtime/build.gradle.kts b/aws-runtime/build.gradle.kts index 25e90ab283c..9d5f8a5cfe6 100644 --- a/aws-runtime/build.gradle.kts +++ b/aws-runtime/build.gradle.kts @@ -3,7 +3,8 @@ * SPDX-License-Identifier: Apache-2.0 */ import aws.sdk.kotlin.gradle.dsl.configurePublishing -import aws.sdk.kotlin.gradle.kmp.* +import aws.sdk.kotlin.gradle.kmp.kotlin +import aws.sdk.kotlin.gradle.kmp.needsKmpConfigured import org.jetbrains.kotlin.gradle.dsl.JvmTarget description = "AWS client runtime support for generated service clients" diff --git a/bom/build.gradle.kts b/bom/build.gradle.kts index 63dc048fc5a..9fa6bde1cce 100644 --- a/bom/build.gradle.kts +++ b/bom/build.gradle.kts @@ -7,8 +7,6 @@ import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension import org.jetbrains.kotlin.gradle.plugin.KotlinMultiplatformPluginWrapper import org.jetbrains.kotlin.gradle.plugin.KotlinTarget import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinMetadataTarget -import org.jetbrains.kotlin.gradle.targets.js.KotlinJsTarget -import java.util.* plugins { `maven-publish` @@ -84,7 +82,6 @@ fun createBomConstraintsAndVersionCatalog() { fun Project.artifactId(target: KotlinTarget): String = when (target) { is KotlinMetadataTarget -> name - is KotlinJsTarget -> "$name-js" else -> "$name-${target.targetName.lowercase()}" } diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/AwsRuntimeTypes.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/AwsRuntimeTypes.kt index 888d060825c..56364a006b2 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/AwsRuntimeTypes.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/AwsRuntimeTypes.kt @@ -37,8 +37,11 @@ object AwsRuntimeTypes { object Config : RuntimeTypePackage(AwsKotlinDependency.AWS_CONFIG) { val AbstractAwsSdkClientFactory = symbol("AbstractAwsSdkClientFactory", "config") + val AwsSdkClientConfig = symbol("AwsSdkClientConfig", "config") + object Endpoints : RuntimeTypePackage(AwsKotlinDependency.AWS_CONFIG, "config.endpoints") { val AccountIdEndpointMode = symbol("AccountIdEndpointMode") + val resolveEndpointDiscoveryEnabled = symbol("resolveEndpointDiscoveryEnabled") val resolveEndpointUrl = symbol("resolveEndpointUrl") val resolveAccountId = symbol("resolveAccountId") val resolveAccountIdEndpointMode = symbol("resolveAccountIdEndpointMode") @@ -56,6 +59,11 @@ object AwsRuntimeTypes { val StaticCredentialsProvider = symbol("StaticCredentialsProvider") val manage = symbol("manage", "auth.credentials.internal", isExtension = true) } + + object Region : RuntimeTypePackage(AwsKotlinDependency.AWS_CONFIG, "region") { + val DefaultRegionProviderChain = symbol("DefaultRegionProviderChain") + val resolveRegion = symbol("resolveRegion") + } } object Http : RuntimeTypePackage(AwsKotlinDependency.AWS_HTTP) { diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/AwsServiceConfigIntegration.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/AwsServiceConfigIntegration.kt index 044fd39bb71..436a6a5aa8e 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/AwsServiceConfigIntegration.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/AwsServiceConfigIntegration.kt @@ -24,20 +24,65 @@ class AwsServiceConfigIntegration : KotlinIntegration { val RegionProp: ConfigProperty = ConfigProperty { name = "region" symbol = KotlinTypes.String.toBuilder().nullable().build() - baseClass = AwsRuntimeTypes.Core.Client.AwsSdkClientConfig + baseClass = AwsRuntimeTypes.Config.AwsSdkClientConfig useNestedBuilderBaseClass() documentation = """ The AWS region (e.g. `us-west-2`) to make requests to. See about AWS - [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more - information + [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more information. + When specified, this static region configuration takes precedence over other region resolution methods. + + The region resolution order is: + 1. Static region (if specified) + 2. Custom region provider (if configured) + 3. Default region provider chain """.trimIndent() + + propertyType = ConfigPropertyType.Custom( + render = { prop, writer -> + writer.write( + "override val #1L: #2T? = builder.#1L ?: #3T { builder.regionProvider?.getRegion() ?: #4T() }", + prop.propertyName, + prop.symbol, + RuntimeTypes.KotlinxCoroutines.runBlocking, + AwsRuntimeTypes.Config.Region.resolveRegion, + ) + }, + ) order = -100 } + val RegionProviderProp: ConfigProperty = ConfigProperty { + name = "regionProvider" + symbol = RuntimeTypes.SmithyClient.Region.RegionProvider + baseClass = AwsRuntimeTypes.Config.AwsSdkClientConfig + useNestedBuilderBaseClass() + documentation = """ + An optional region provider that determines the AWS region for client operations. When specified, this provider + takes precedence over the default region provider chain, unless a static region is explicitly configured. + + The region resolution order is: + 1. Static region (if specified) + 2. Custom region provider (if configured) + 3. Default region provider chain + """.trimIndent() + + propertyType = ConfigPropertyType.Custom( + render = { prop, writer -> + writer.write( + "override val #1L: #2T = builder.#1L ?: #3T()", + prop.propertyName, + prop.symbol, + AwsRuntimeTypes.Config.Region.DefaultRegionProviderChain, + ) + }, + ) + order = -99 // After RegionProp + } + val UserAgentAppId: ConfigProperty = ConfigProperty { name = "applicationId" symbol = KotlinTypes.String.asNullable() - baseClass = AwsRuntimeTypes.Core.Client.AwsSdkClientConfig + baseClass = AwsRuntimeTypes.Config.AwsSdkClientConfig useNestedBuilderBaseClass() documentation = """ An optional application specific identifier. @@ -132,6 +177,7 @@ class AwsServiceConfigIntegration : KotlinIntegration { override fun additionalServiceConfigProps(ctx: CodegenContext): List = buildList { add(RegionProp) + add(RegionProviderProp) if (AwsSignatureVersion4.isSupportedAuthentication(ctx.model, ctx.settings.getService(ctx.model))) { add(CredentialsProviderProp) } diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/PresignerGenerator.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/PresignerGenerator.kt index f8c33308a42..6bd8647616e 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/PresignerGenerator.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/PresignerGenerator.kt @@ -44,7 +44,6 @@ class PresignerGenerator : KotlinIntegration { * signing. */ object UnsignedRequestCustomizationSection : SectionId { - val CodegenContext: SectionKey = SectionKey("CodegenContext") val OperationId: SectionKey = SectionKey("OperationId") val HttpBindingResolver: SectionKey = SectionKey("HttpBindingResolver") val DefaultTimestampFormat: SectionKey = SectionKey("DefaultTimestampFormat") @@ -126,7 +125,6 @@ class PresignerGenerator : KotlinIntegration { val contextMap: Map, Any> = mapOf( UnsignedRequestCustomizationSection.OperationId to op.id.toString(), - UnsignedRequestCustomizationSection.CodegenContext to ctx, UnsignedRequestCustomizationSection.HttpBindingResolver to httpBindingResolver, UnsignedRequestCustomizationSection.DefaultTimestampFormat to defaultTimestampFormat, ) diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/ReplaceServiceExceptionBase.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/ReplaceServiceExceptionBase.kt index 6e8cca55967..2f063721cf9 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/ReplaceServiceExceptionBase.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/ReplaceServiceExceptionBase.kt @@ -27,7 +27,7 @@ class ReplaceServiceExceptionBase : KotlinIntegration { get() = listOf(SectionWriterBinding(ExceptionBaseClassGenerator.ExceptionBaseClassSection, exceptionSectionWriter)) private val exceptionSectionWriter = SectionWriter { writer, _ -> - val ctx = writer.getContextValue(ExceptionBaseClassGenerator.ExceptionBaseClassSection.CodegenContext) + val ctx = writer.getContextValue(CodegenContext.Key) AwsServiceExceptionBaseClassGenerator().render(ctx, writer) } } diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/polly/PollyPresigner.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/polly/PollyPresigner.kt index fb239a71dfd..7e0239404a3 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/polly/PollyPresigner.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/polly/PollyPresigner.kt @@ -36,7 +36,7 @@ class PollyPresigner : KotlinIntegration { } private val customizeUnsignedRequest = SectionWriter { writer, _ -> - val ctx = writer.getContextValue(PresignerGenerator.UnsignedRequestCustomizationSection.CodegenContext) + val ctx = writer.getContextValue(CodegenContext.Key) val operation = ctx.model.expectShape(writer.getContextValue(PresignerGenerator.UnsignedRequestCustomizationSection.OperationId)) val resolver = writer.getContextValue(PresignerGenerator.UnsignedRequestCustomizationSection.HttpBindingResolver) val defaultTimestampFormat = writer.getContextValue(PresignerGenerator.UnsignedRequestCustomizationSection.DefaultTimestampFormat) diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/endpoints/AwsEndpointDiscoveryIntegration.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/endpoints/AwsEndpointDiscoveryIntegration.kt new file mode 100644 index 00000000000..00184869dd2 --- /dev/null +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/endpoints/AwsEndpointDiscoveryIntegration.kt @@ -0,0 +1,95 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ +package aws.sdk.kotlin.codegen.endpoints + +import aws.sdk.kotlin.codegen.AwsRuntimeTypes +import aws.sdk.kotlin.codegen.ServiceClientCompanionObjectWriter +import software.amazon.smithy.kotlin.codegen.KotlinSettings +import software.amazon.smithy.kotlin.codegen.core.CodegenContext +import software.amazon.smithy.kotlin.codegen.core.KotlinDelegator +import software.amazon.smithy.kotlin.codegen.core.getContextValue +import software.amazon.smithy.kotlin.codegen.integration.AppendingSectionWriter +import software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration +import software.amazon.smithy.kotlin.codegen.integration.SectionWriterBinding +import software.amazon.smithy.kotlin.codegen.model.asNullable +import software.amazon.smithy.kotlin.codegen.rendering.endpoints.discovery.DefaultEndpointDiscovererGenerator +import software.amazon.smithy.kotlin.codegen.rendering.endpoints.discovery.EndpointDiscovererInterfaceGenerator +import software.amazon.smithy.kotlin.codegen.rendering.endpoints.discovery.EndpointDiscoveryIntegration +import software.amazon.smithy.kotlin.codegen.rendering.util.ConfigProperty +import software.amazon.smithy.kotlin.codegen.rendering.util.ConfigPropertyType +import software.amazon.smithy.model.Model + +class AwsEndpointDiscoveryIntegration : KotlinIntegration { + override val order: Byte = (EndpointDiscoveryIntegration.ORDER + 1).toByte() // after EndpointDiscoveryIntegration + + override fun additionalServiceConfigProps(ctx: CodegenContext): List { + val endpointDiscoveryOptional = EndpointDiscoveryIntegration.isOptionalFor(ctx) + val interfaceSymbol = EndpointDiscovererInterfaceGenerator.symbolFor(ctx.settings) + return listOf( + ConfigProperty { + name = EndpointDiscoveryIntegration.CLIENT_CONFIG_NAME + symbol = interfaceSymbol.asNullable() + + if (endpointDiscoveryOptional) { + documentation = """ + The endpoint discoverer for this client, if applicable. By default, no endpoint discovery is + provided. To use endpoint discovery, set this to a valid [${interfaceSymbol.name}] instance. + """.trimIndent() + propertyType = ConfigPropertyType.SymbolDefault + } else { + val defaultImplSymbol = DefaultEndpointDiscovererGenerator.symbolFor(ctx.settings) + + documentation = """ + The endpoint discoverer for this client, [${defaultImplSymbol.name}] by default. + """.trimIndent() + propertyType = ConfigPropertyType.Custom( + render = { prop, writer -> + writer.write( + "#1L val #2L: #3T = builder.#2L ?: #4T()", + ctx.settings.api.visibility, + prop.propertyName, + prop.symbol, + defaultImplSymbol, + ) + }, + ) + } + }, + ) + } + + override fun enabledForService(model: Model, settings: KotlinSettings): Boolean = + EndpointDiscoveryIntegration.isEnabledFor(model, settings) + + private val resolveEndpointDiscoverer = AppendingSectionWriter { writer -> + val ctx = writer.getContextValue(CodegenContext.Key) + val endpointDiscoveryOptional = EndpointDiscoveryIntegration.isOptionalFor(ctx) + + writer.write( + "val epDiscoveryEnabled = #T(profile = activeProfile, serviceRequiresEpDiscovery = #L)", + AwsRuntimeTypes.Config.Endpoints.resolveEndpointDiscoveryEnabled, + !endpointDiscoveryOptional, + ) + + writer.write( + "builder.config.#1L = builder.config.#1L ?: if (epDiscoveryEnabled) #2T() else null", + EndpointDiscoveryIntegration.CLIENT_CONFIG_NAME, + DefaultEndpointDiscovererGenerator.symbolFor(ctx.settings), + ) + } + + override val sectionWriters = listOf( + SectionWriterBinding(ServiceClientCompanionObjectWriter.FinalizeEnvironmentalConfig, resolveEndpointDiscoverer), + ) + + override fun writeAdditionalFiles(ctx: CodegenContext, delegator: KotlinDelegator) { + // EndpointDiscoveryIntegration already renders the default endpoint discoverer for services that _require_ EP + // discovery. So we only need to render it for services which _do not require_ EP discovery in order to support + // enabling discovery via environmental config. + if (EndpointDiscoveryIntegration.isOptionalFor(ctx)) { + DefaultEndpointDiscovererGenerator(ctx, delegator).render() + } + } +} diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/endpoints/BindAwsEndpointBuiltins.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/endpoints/BindAwsEndpointBuiltins.kt index c4c49adc48f..7696113d99a 100644 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/endpoints/BindAwsEndpointBuiltins.kt +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/endpoints/BindAwsEndpointBuiltins.kt @@ -38,7 +38,7 @@ class BindAwsEndpointBuiltins : KotlinIntegration { Flag to toggle whether to use [FIPS](https://aws.amazon.com/compliance/fips/) endpoints when making requests. ` Disabled by default. """.trimIndent() - baseClass = AwsRuntimeTypes.Core.Client.AwsSdkClientConfig + baseClass = AwsRuntimeTypes.Config.AwsSdkClientConfig useNestedBuilderBaseClass() } @@ -50,7 +50,7 @@ class BindAwsEndpointBuiltins : KotlinIntegration { See [https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html] for more information. ` Disabled by default. """.trimIndent() - baseClass = AwsRuntimeTypes.Core.Client.AwsSdkClientConfig + baseClass = AwsRuntimeTypes.Config.AwsSdkClientConfig useNestedBuilderBaseClass() } } 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 7883eea4c35..dd4f34e4913 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 @@ -7,6 +7,7 @@ aws.sdk.kotlin.codegen.customization.DefaultMiddleware aws.sdk.kotlin.codegen.customization.AccountIdEndpointBuiltinCustomization aws.sdk.kotlin.codegen.customization.PresignableModelIntegration aws.sdk.kotlin.codegen.customization.BackfillOptionalAuth +aws.sdk.kotlin.codegen.endpoints.AwsEndpointDiscoveryIntegration aws.sdk.kotlin.codegen.endpoints.BindAwsEndpointBuiltins aws.sdk.kotlin.codegen.endpoints.AddAwsEndpointFunctions aws.sdk.kotlin.codegen.PresignerGenerator 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 0885ec55dc5..2bd5184a39a 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 @@ -1783,6 +1783,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-5" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "api.iot-tunneling-fips.ca-central-1.api.aws", @@ -1807,6 +1808,7 @@ "tags" : [ "dualstack" ] } ] }, + "eu-south-2" : { }, "eu-west-1" : { "variants" : [ { "hostname" : "api.iot-tunneling.eu-west-1.api.aws", @@ -3779,6 +3781,7 @@ "ap-south-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-4" : { }, "bedrock-ap-northeast-1" : { "credentialScope" : { "region" : "ap-northeast-1" @@ -4079,6 +4082,7 @@ "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, + "us-west-1" : { }, "us-west-2" : { } } }, @@ -5505,6 +5509,20 @@ } } }, + "codeguru-profiler" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, "codeguru-reviewer" : { "endpoints" : { "ap-northeast-1" : { }, @@ -5729,6 +5747,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "cognito-identity.ca-central-1.amazonaws.com", @@ -5835,6 +5854,7 @@ "tags" : [ "dualstack" ] } ] }, + "mx-central-1" : { }, "sa-east-1" : { "variants" : [ { "hostname" : "cognito-identity.sa-east-1.amazonaws.com", @@ -5965,6 +5985,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "cognito-idp.ca-central-1.amazonaws.com", @@ -6071,6 +6092,7 @@ "tags" : [ "dualstack" ] } ] }, + "mx-central-1" : { }, "sa-east-1" : { "variants" : [ { "hostname" : "cognito-idp.sa-east-1.amazonaws.com", @@ -6695,6 +6717,7 @@ "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, + "ap-east-2" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-northeast-3" : { }, @@ -6828,6 +6851,7 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-5" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "data.iot-fips.ca-central-1.amazonaws.com", @@ -6836,6 +6860,7 @@ }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -6999,6 +7024,7 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-5" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "data.jobs.iot-fips.ca-central-1.amazonaws.com", @@ -7007,6 +7033,7 @@ }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -7045,6 +7072,7 @@ "deprecated" : true, "hostname" : "data.jobs.iot-fips.us-west-2.amazonaws.com" }, + "me-central-1" : { }, "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { @@ -12294,6 +12322,7 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-5" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "greengrass-fips.ca-central-1.amazonaws.com", @@ -12301,6 +12330,7 @@ } ] }, "eu-central-1" : { }, + "eu-south-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "fips-ca-central-1" : { @@ -12462,6 +12492,7 @@ "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, + "ap-east-2" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-northeast-3" : { }, @@ -13179,6 +13210,7 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-5" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "iot-fips.ca-central-1.amazonaws.com", @@ -13187,6 +13219,7 @@ }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -13970,6 +14003,7 @@ "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-south-1" : { }, + "ap-south-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "ca-central-1" : { }, @@ -14369,11 +14403,14 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-5" : { }, "ca-central-1" : { }, "eu-central-1" : { }, + "eu-south-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -15298,6 +15335,7 @@ "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, + "ap-east-2" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-northeast-3" : { }, @@ -15382,6 +15420,7 @@ "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, + "ap-east-2" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-northeast-3" : { }, @@ -15466,6 +15505,7 @@ "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, + "ap-east-2" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-northeast-3" : { }, @@ -15553,6 +15593,7 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -17429,6 +17470,7 @@ "endpoints" : { "af-south-1" : { }, "ap-east-1" : { }, + "ap-east-2" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-northeast-3" : { }, @@ -21428,7 +21470,10 @@ "ap-southeast-2" : { }, "ap-southeast-3" : { }, "ap-southeast-4" : { }, + "ap-southeast-5" : { }, + "ap-southeast-7" : { }, "ca-central-1" : { }, + "ca-west-1" : { }, "eu-central-1" : { }, "eu-central-2" : { }, "eu-north-1" : { }, @@ -21440,6 +21485,7 @@ "il-central-1" : { }, "me-central-1" : { }, "me-south-1" : { }, + "mx-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -22813,6 +22859,7 @@ "tags" : [ "dualstack" ] } ] }, + "ap-east-2" : { }, "ap-northeast-1" : { "variants" : [ { "hostname" : "securityhub.ap-northeast-1.api.aws", @@ -27273,6 +27320,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "transfer-fips.ca-central-1.amazonaws.com", @@ -36695,7 +36743,8 @@ }, "batch" : { "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "bedrock" : { @@ -37614,6 +37663,12 @@ "us-iso-west-1" : { } } }, + "servicequotas" : { + "endpoints" : { + "us-iso-east-1" : { }, + "us-iso-west-1" : { } + } + }, "snowball" : { "endpoints" : { "us-iso-east-1" : { }, @@ -38562,6 +38617,11 @@ "us-isob-east-1" : { } } }, + "servicequotas" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, "snowball" : { "endpoints" : { "us-isob-east-1" : { } diff --git a/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/AwsServiceConfigIntegrationTest.kt b/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/AwsServiceConfigIntegrationTest.kt index 9303d312e12..a35643213eb 100644 --- a/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/AwsServiceConfigIntegrationTest.kt +++ b/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/AwsServiceConfigIntegrationTest.kt @@ -45,7 +45,8 @@ class AwsServiceConfigIntegrationTest { val contents = writer.toString() val expectedProps = """ - override val region: String? = builder.region + override val region: String? = builder.region ?: runBlocking { builder.regionProvider?.getRegion() ?: resolveRegion() } + override val regionProvider: RegionProvider = builder.regionProvider ?: DefaultRegionProviderChain() override val credentialsProvider: CredentialsProvider = builder.credentialsProvider ?: DefaultChainCredentialsProvider(httpClient = httpClient, region = region).manage() """ contents.shouldContainOnlyOnceWithDiff(expectedProps) @@ -53,11 +54,27 @@ class AwsServiceConfigIntegrationTest { val expectedImpl = """ /** * The AWS region (e.g. `us-west-2`) to make requests to. See about AWS - * [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more - * information + * [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more information. + * When specified, this static region configuration takes precedence over other region resolution methods. + * + * The region resolution order is: + * 1. Static region (if specified) + * 2. Custom region provider (if configured) + * 3. Default region provider chain */ override var region: String? = null + /** + * An optional region provider that determines the AWS region for client operations. When specified, this provider + * takes precedence over the default region provider chain, unless a static region is explicitly configured. + * + * The region resolution order is: + * 1. Static region (if specified) + * 2. Custom region provider (if configured) + * 3. Default region provider chain + */ + override var regionProvider: RegionProvider? = null + /** * The AWS credentials provider to use for authenticating requests. If not provided a * [aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider] instance will be used. diff --git a/codegen/sdk/aws-models/acm-pca.json b/codegen/sdk/aws-models/acm-pca.json index 4ba7e4e062f..da7199946c7 100644 --- a/codegen/sdk/aws-models/acm-pca.json +++ b/codegen/sdk/aws-models/acm-pca.json @@ -87,7 +87,7 @@ "name": "acm-pca" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

This is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions,\n\t\t\tsyntax, and usage examples for each of the actions and data types involved in creating\n\t\t\tand managing a private certificate authority (CA) for your organization.

\n

The documentation for each action shows the API request parameters and the JSON\n\t\t\tresponse. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is\n\t\t\ttailored to the programming language or platform that you prefer. For more information,\n\t\t\tsee Amazon Web Services SDKs.

\n

Each Amazon Web Services Private CA API operation has a quota that determines the number of times the\n\t\t\toperation can be called per second. Amazon Web Services Private CA throttles API requests at different rates\n\t\t\tdepending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid\n\t\t\trequest because the request exceeds the operation's quota for the number of requests per\n\t\t\tsecond. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request\n\t\t\trate for APIs.

\n

To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,\n\t\t\tlog into your Amazon Web Services account and visit the Service Quotas\n\t\t\tconsole.

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

This is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.

The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see Amazon Web Services SDKs.

Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs.

To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the Service Quotas console.

", "smithy.api#title": "AWS Certificate Manager Private Certificate Authority", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1111,19 +1111,19 @@ "Country": { "target": "com.amazonaws.acmpca#CountryCodeString", "traits": { - "smithy.api#documentation": "

Two-digit code that specifies the country in which the certificate subject\n\t\t\tlocated.

" + "smithy.api#documentation": "

Two-digit code that specifies the country in which the certificate subject located.

" } }, "Organization": { "target": "com.amazonaws.acmpca#String64", "traits": { - "smithy.api#documentation": "

Legal name of the organization with which the certificate subject is affiliated.\n\t\t

" + "smithy.api#documentation": "

Legal name of the organization with which the certificate subject is affiliated.

" } }, "OrganizationalUnit": { "target": "com.amazonaws.acmpca#String64", "traits": { - "smithy.api#documentation": "

A subdivision or unit of the organization (such as sales or finance) with which the\n\t\t\tcertificate subject is affiliated.

" + "smithy.api#documentation": "

A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.

" } }, "DistinguishedNameQualifier": { @@ -1141,7 +1141,7 @@ "CommonName": { "target": "com.amazonaws.acmpca#String64", "traits": { - "smithy.api#documentation": "

For CA and end-entity certificates in a private PKI, the common name (CN) can be any\n\t\t\tstring within the length limit.

\n

Note: In publicly trusted certificates, the common name must be a fully qualified\n\t\t\tdomain name (FQDN) associated with the certificate subject.

" + "smithy.api#documentation": "

For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.

Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.

" } }, "SerialNumber": { @@ -1153,19 +1153,19 @@ "Locality": { "target": "com.amazonaws.acmpca#String128", "traits": { - "smithy.api#documentation": "

The locality (such as a city or town) in which the certificate subject is\n\t\t\tlocated.

" + "smithy.api#documentation": "

The locality (such as a city or town) in which the certificate subject is located.

" } }, "Title": { "target": "com.amazonaws.acmpca#String64", "traits": { - "smithy.api#documentation": "

A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the\n\t\t\tcertificate subject.

" + "smithy.api#documentation": "

A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.

" } }, "Surname": { "target": "com.amazonaws.acmpca#String40", "traits": { - "smithy.api#documentation": "

Family name. In the US and the UK, for example, the surname of an individual is\n\t\t\tordered last. In Asian cultures the surname is typically ordered first.

" + "smithy.api#documentation": "

Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.

" } }, "GivenName": { @@ -1177,30 +1177,30 @@ "Initials": { "target": "com.amazonaws.acmpca#String5", "traits": { - "smithy.api#documentation": "

Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the\n\t\t\tfirst letter of the Surname.

" + "smithy.api#documentation": "

Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname.

" } }, "Pseudonym": { "target": "com.amazonaws.acmpca#String128", "traits": { - "smithy.api#documentation": "

Typically a shortened version of a longer GivenName.\n\t\t\tFor example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth,\n\t\t\tLiz, or Eliza.

" + "smithy.api#documentation": "

Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.

" } }, "GenerationQualifier": { "target": "com.amazonaws.acmpca#String3", "traits": { - "smithy.api#documentation": "

Typically a qualifier appended to the name of an individual. Examples include Jr. for\n\t\t\tjunior, Sr. for senior, and III for third.

" + "smithy.api#documentation": "

Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.

" } }, "CustomAttributes": { "target": "com.amazonaws.acmpca#CustomAttributeList", "traits": { - "smithy.api#documentation": "

\n

Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of\n\t\t\twhich consists of an object identifier (OID) and a value. For more information, see\n\t\t\tNIST’s definition of Object Identifier (OID).

\n \n

Custom attributes cannot be used in combination with standard attributes.

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

Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).

Custom attributes cannot be used in combination with standard attributes.

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

Contains information about the certificate subject. The Subject field in\n\t\t\tthe certificate identifies the entity that owns or controls the public key in the\n\t\t\tcertificate. The entity can be a user, computer, device, or service. The Subject\n\t\t\tmust contain an X.500 distinguished name (DN). A DN is a sequence of relative\n\t\t\tdistinguished names (RDNs). The RDNs are separated by commas in the certificate.

" + "smithy.api#documentation": "

Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

" } }, "com.amazonaws.acmpca#AWSPolicy": { @@ -1232,7 +1232,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides access information used by the authorityInfoAccess and\n\t\t\t\tsubjectInfoAccess extensions described in RFC 5280.

" + "smithy.api#documentation": "

Provides access information used by the authorityInfoAccess and subjectInfoAccess extensions described in RFC 5280.

" } }, "com.amazonaws.acmpca#AccessDescriptionList": { @@ -1247,7 +1247,7 @@ "CustomObjectIdentifier": { "target": "com.amazonaws.acmpca#CustomObjectIdentifier", "traits": { - "smithy.api#documentation": "

An object identifier (OID) specifying the AccessMethod. The OID must\n\t\t\tsatisfy the regular expression shown below. For more information, see NIST's definition\n\t\t\tof Object Identifier\n\t\t\t\t(OID).

" + "smithy.api#documentation": "

An object identifier (OID) specifying the AccessMethod. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID).

" } }, "AccessMethodType": { @@ -1258,7 +1258,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the type and format of extension access. Only one of\n\t\t\t\tCustomObjectIdentifier or AccessMethodType may be\n\t\t\tprovided. Providing both results in InvalidArgsException.

" + "smithy.api#documentation": "

Describes the type and format of extension access. Only one of CustomObjectIdentifier or AccessMethodType may be provided. Providing both results in InvalidArgsException.

" } }, "com.amazonaws.acmpca#AccessMethodType": { @@ -1343,7 +1343,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains X.509 certificate information to be placed in an issued certificate. An\n\t\t\t\tAPIPassthrough or APICSRPassthrough template variant must\n\t\t\tbe selected, or else this parameter is ignored.

\n

If conflicting or duplicate certificate information is supplied from other sources,\n\t\t\tAmazon Web Services Private CA applies order of\n\t\t\t\toperation rules to determine what information is used.

" + "smithy.api#documentation": "

Contains X.509 certificate information to be placed in an issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored.

If conflicting or duplicate certificate information is supplied from other sources, Amazon Web Services Private CA applies order of operation rules to determine what information is used.

" } }, "com.amazonaws.acmpca#Arn": { @@ -1434,7 +1434,7 @@ "Arn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) for your private certificate authority (CA). The format is\n\t\t\t\t\t\n 12345678-1234-1234-1234-123456789012\n .

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .

" } }, "OwnerAccount": { @@ -1500,30 +1500,30 @@ "RevocationConfiguration": { "target": "com.amazonaws.acmpca#RevocationConfiguration", "traits": { - "smithy.api#documentation": "

Information about the Online Certificate Status Protocol (OCSP) configuration or\n\t\t\tcertificate revocation list (CRL) created and maintained by your private CA.

" + "smithy.api#documentation": "

Information about the Online Certificate Status Protocol (OCSP) configuration or certificate revocation list (CRL) created and maintained by your private CA.

" } }, "RestorableUntil": { "target": "com.amazonaws.acmpca#TStamp", "traits": { - "smithy.api#documentation": "

The period during which a deleted CA can be restored. For more information, see the\n\t\t\t\tPermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.

" + "smithy.api#documentation": "

The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.

" } }, "KeyStorageSecurityStandard": { "target": "com.amazonaws.acmpca#KeyStorageSecurityStandard", "traits": { - "smithy.api#documentation": "

Defines a cryptographic key management compliance standard used for handling CA keys.

\n

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

\n

Note: Amazon Web Services Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must\n\t\t\texplicitly specify this parameter and value when creating a CA in that Region.\n\t\t\tSpecifying a different value (or no value) results in an\n\t\t\t\tInvalidArgsException with the message \"A certificate authority cannot\n\t\t\tbe created in this region with the specified security standard.\"

" + "smithy.api#documentation": "

Defines a cryptographic key management compliance standard for handling and protecting CA keys.

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

Starting January 26, 2023, Amazon Web Services Private CA protects all CA private keys in non-China regions using hardware security modules (HSMs) that comply with FIPS PUB 140-2 Level 3.

For information about security standard support in different Amazon Web Services Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.

" } }, "UsageMode": { "target": "com.amazonaws.acmpca#CertificateAuthorityUsageMode", "traits": { - "smithy.api#documentation": "

Specifies whether the CA issues general-purpose certificates that typically require a\n\t\t\trevocation mechanism, or short-lived certificates that may optionally omit revocation\n\t\t\tbecause they expire quickly. Short-lived certificate validity is limited to seven\n\t\t\tdays.

\n

The default value is GENERAL_PURPOSE.

" + "smithy.api#documentation": "

Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

The default value is GENERAL_PURPOSE.

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

Contains information about your private certificate authority (CA). Your private CA\n\t\t\tcan issue and revoke X.509 digital certificates. Digital certificates verify that the\n\t\t\tentity named in the certificate Subject field owns or\n\t\t\tcontrols the public key contained in the Subject Public Key\n\t\t\t\tInfo field. Call the CreateCertificateAuthority action to create your private CA. You must then\n\t\t\tcall the GetCertificateAuthorityCertificate action to retrieve a private CA\n\t\t\tcertificate signing request (CSR). Sign the CSR with your Amazon Web Services Private CA-hosted or\n\t\t\ton-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed\n\t\t\tcertificate into Certificate Manager (ACM).

" + "smithy.api#documentation": "

Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into Certificate Manager (ACM).

" } }, "com.amazonaws.acmpca#CertificateAuthorityConfiguration": { @@ -1532,33 +1532,33 @@ "KeyAlgorithm": { "target": "com.amazonaws.acmpca#KeyAlgorithm", "traits": { - "smithy.api#documentation": "

Type of the public key algorithm and size, in bits, of the key pair that your CA\n\t\t\tcreates when it issues a certificate. When you create a subordinate CA, you must use a\n\t\t\tkey algorithm supported by the parent CA.

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

Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.

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

Name of the algorithm your private CA uses to sign certificate requests.

\n

This parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign certificates when they are issued.

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

Name of the algorithm your private CA uses to sign certificate requests.

This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.

", "smithy.api#required": {} } }, "Subject": { "target": "com.amazonaws.acmpca#ASN1Subject", "traits": { - "smithy.api#documentation": "

Structure that contains X.500 distinguished name information for your private\n\t\t\tCA.

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

Structure that contains X.500 distinguished name information for your private CA.

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

Specifies information to be added to the extension section of the certificate signing\n\t\t\trequest (CSR).

" + "smithy.api#documentation": "

Specifies information to be added to the extension section of the certificate signing request (CSR).

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

Contains configuration information for your private certificate authority (CA). This\n\t\t\tincludes information about the class of public key algorithm and the key pair that your\n\t\t\tprivate CA creates when it issues a certificate. It also includes the signature\n\t\t\talgorithm that it uses when issuing certificates, and its X.500 distinguished name. You\n\t\t\tmust specify this information when you call the CreateCertificateAuthority action.

" + "smithy.api#documentation": "

Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate. It also includes the signature algorithm that it uses when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority action.

" } }, "com.amazonaws.acmpca#CertificateAuthorityStatus": { @@ -1674,7 +1674,7 @@ } }, "traits": { - "smithy.api#documentation": "

The certificate authority certificate you are importing does not comply with\n\t\t\tconditions specified in the certificate that signed it.

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

The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.

", "smithy.api#error": "client" } }, @@ -1745,7 +1745,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a root or subordinate private certificate authority (CA). You must specify the\n\t\t\tCA configuration, an optional configuration for Online Certificate Status Protocol\n\t\t\t(OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional\n\t\t\tidempotency token to avoid accidental creation of multiple CAs. The CA configuration\n\t\t\tspecifies the name of the algorithm and key size to be used to create the CA private\n\t\t\tkey, the type of signing algorithm that the CA uses, and X.500 subject information. The\n\t\t\tOCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL\n\t\t\tconfiguration specifies the CRL expiration period in days (the validity period of the\n\t\t\tCRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3\n\t\t\tbucket that is included in certificates issued by the CA. If successful, this action\n\t\t\treturns the Amazon Resource Name (ARN) of the CA.

\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\n\t\t\tCRLs.

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

Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.

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

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

", "smithy.api#idempotent": {} } }, @@ -1778,7 +1778,7 @@ } ], "traits": { - "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#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 the private key.

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.

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

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

", "smithy.api#idempotent": {} } }, @@ -1788,7 +1788,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .

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

The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

", "smithy.api#required": {} } }, @@ -1823,7 +1823,7 @@ "S3Key": { "target": "com.amazonaws.acmpca#S3Key", "traits": { - "smithy.api#documentation": "

The key that uniquely identifies the report file in\n\t\t\tyour S3 bucket.

" + "smithy.api#documentation": "

The key that uniquely identifies the report file in your S3 bucket.

" } } }, @@ -1837,14 +1837,14 @@ "CertificateAuthorityConfiguration": { "target": "com.amazonaws.acmpca#CertificateAuthorityConfiguration", "traits": { - "smithy.api#documentation": "

Name and bit size of the private key algorithm, the name of the signing algorithm, and\n\t\t\tX.500 certificate subject information.

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

Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.

", "smithy.api#required": {} } }, "RevocationConfiguration": { "target": "com.amazonaws.acmpca#RevocationConfiguration", "traits": { - "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.

" + "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.

The following requirements apply to revocation configurations.

  • A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.

  • In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.

  • A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.

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

For more information, see the OcspConfiguration and CrlConfiguration types.

" } }, "CertificateAuthorityType": { @@ -1857,25 +1857,25 @@ "IdempotencyToken": { "target": "com.amazonaws.acmpca#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for\n\t\t\t\tCreateCertificateAuthority time out after five\n\t\t\tminutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency\n\t\t\ttoken within five minutes, Amazon Web Services Private CA recognizes that you are requesting only\n\t\t\tcertificate authority and will issue only one. If you change the idempotency token for\n\t\t\teach call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate\n\t\t\tauthorities.

" + "smithy.api#documentation": "

Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for CreateCertificateAuthority time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate authorities.

" } }, "KeyStorageSecurityStandard": { "target": "com.amazonaws.acmpca#KeyStorageSecurityStandard", "traits": { - "smithy.api#documentation": "

Specifies a cryptographic key management compliance standard used for handling CA\n\t\t\tkeys.

\n

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

\n \n

Some Amazon Web Services Regions do not support the default. When creating a CA in these\n\t\t\t\tRegions, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument\n\t\t\t\tfor KeyStorageSecurityStandard. Failure to do this results in an\n\t\t\t\t\tInvalidArgsException with the message, \"A certificate authority\n\t\t\t\tcannot be created in this region with the specified security standard.\"

\n

For information about security standard support in various Regions, see Storage\n\t\t\t\t\tand security compliance of Amazon Web Services Private CA private keys.

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

Specifies a cryptographic key management compliance standard for handling and protecting CA keys.

Default: FIPS_140_2_LEVEL_3_OR_HIGHER

Some Amazon Web Services Regions don't support the default value. When you create a CA in these Regions, you must use CCPC_LEVEL_1_OR_HIGHER for the KeyStorageSecurityStandard parameter. If you don't, the operation returns an InvalidArgsException with this message: \"A certificate authority cannot be created in this region with the specified security standard.\"

For information about security standard support in different Amazon Web Services Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.

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

Key-value pairs that will be attached to the new private CA. You can associate up to\n\t\t\t50 tags with a private CA. For information using tags with IAM to manage permissions,\n\t\t\tsee Controlling Access Using IAM Tags.

" + "smithy.api#documentation": "

Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags.

" } }, "UsageMode": { "target": "com.amazonaws.acmpca#CertificateAuthorityUsageMode", "traits": { - "smithy.api#documentation": "

Specifies whether the CA issues general-purpose certificates that typically require a\n\t\t\trevocation mechanism, or short-lived certificates that may optionally omit revocation\n\t\t\tbecause they expire quickly. Short-lived certificate validity is limited to seven\n\t\t\tdays.

\n

The default value is GENERAL_PURPOSE.

" + "smithy.api#documentation": "

Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.

The default value is GENERAL_PURPOSE.

" } } }, @@ -1889,7 +1889,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This\n\t\t\tis of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

" + "smithy.api#documentation": "

If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

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

Grants one or more permissions on a private CA to the Certificate Manager (ACM) service\n\t\t\tprincipal (acm.amazonaws.com). These permissions allow ACM to issue and\n\t\t\trenew ACM certificates that reside in the same Amazon Web Services account as the CA.

\n

You can list current permissions with the ListPermissions action and\n\t\t\trevoke them with the DeletePermission action.

\n

\n About Permissions\n

\n
    \n
  • \n

    If the private CA and the certificates it issues reside in the same \n\t\t\taccount, you can use CreatePermission to grant permissions for ACM to \n\t\t\tcarry out automatic certificate renewals.

    \n
    • \n
  • \n

    For automatic certificate renewal to succeed, the ACM service principal\n\t\t\tneeds permissions to create, retrieve, and list certificates.

    \n
    • \n
  • \n

    If the private CA and the ACM certificates reside in different accounts, \n\t\t\tthen permissions cannot be used to enable automatic renewals. Instead, \n\t\t\tthe ACM certificate owner must set up a resource-based policy to enable \n\t\t\tcross-account issuance and renewals. For more information, see \n\t\t\tUsing a Resource\n\t\t\tBased Policy with Amazon Web Services Private CA.

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

Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.

" } }, "com.amazonaws.acmpca#CreatePermissionRequest": { @@ -1935,14 +1935,14 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the\n\t\t\tARN by calling the ListCertificateAuthorities action. This must have the following form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

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

The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the ListCertificateAuthorities action. This must have the following form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

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

The Amazon Web Services service or identity that receives the permission. At this time, the only\n\t\t\tvalid principal is acm.amazonaws.com.

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

The Amazon Web Services service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.

", "smithy.api#required": {} } }, @@ -1955,7 +1955,7 @@ "Actions": { "target": "com.amazonaws.acmpca#ActionList", "traits": { - "smithy.api#documentation": "

The actions that the specified Amazon Web Services service principal can use. These include\n\t\t\t\tIssueCertificate, GetCertificate, and\n\t\t\t\tListPermissions.

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

The actions that the specified Amazon Web Services service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions.

", "smithy.api#required": {} } } @@ -1971,7 +1971,7 @@ "target": "com.amazonaws.acmpca#Boolean", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.\n\t\t\tYou can use this value to enable certificate revocation for a new CA when you call the\n\t\t\t\tCreateCertificateAuthority action or for an existing CA when you call the\n\t\t\t\tUpdateCertificateAuthority action.

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

Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.

", "smithy.api#required": {} } }, @@ -1984,19 +1984,19 @@ "CustomCname": { "target": "com.amazonaws.acmpca#CnameString", "traits": { - "smithy.api#documentation": "

Name inserted into the certificate CRL Distribution\n\t\t\t\tPoints extension that enables the use of an alias for the CRL\n\t\t\tdistribution point. Use this value if you don't want the name of your S3 bucket to be\n\t\t\tpublic.

\n \n

The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the\n\t\t\t\tuse of special characters in URIs. Additionally, the value of the CNAME must not\n\t\t\t\tinclude a protocol prefix such as \"http://\" or \"https://\".

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

Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.

The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\".

" } }, "S3BucketName": { "target": "com.amazonaws.acmpca#S3BucketName3To255", "traits": { - "smithy.api#documentation": "

Name of the S3 bucket that contains the CRL. If you do not provide a value for the\n\t\t\t\tCustomCname argument, the name of your S3 bucket\n\t\t\tis placed into the CRL Distribution Points extension of\n\t\t\tthe issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket\n\t\t\t\tpolicy that allows Amazon Web Services Private CA to write the CRL to your bucket.

\n \n

The S3BucketName parameter must conform to the S3\n\t\t\t\t\tbucket naming rules.

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

Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows Amazon Web Services Private CA to write the CRL to your bucket.

The S3BucketName parameter must conform to the S3 bucket naming rules.

" } }, "S3ObjectAcl": { "target": "com.amazonaws.acmpca#S3ObjectAcl", "traits": { - "smithy.api#documentation": "

Determines whether the CRL will be publicly readable or privately held in the CRL\n\t\t\tAmazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public\n\t\t\tinternet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket\n\t\t\tcan access the CRL, and your PKI clients may need an alternative method of access.

\n

If no value is specified, the default is PUBLIC_READ.

\n

\n Note: This default can cause CA creation to fail in some\n\t\t\tcircumstances. If you have have enabled the Block Public Access (BPA) feature in your S3\n\t\t\taccount, then you must specify the value of this parameter as\n\t\t\t\tBUCKET_OWNER_FULL_CONTROL, and not doing so results in an error. If you\n\t\t\thave disabled BPA in S3, then you can specify either\n\t\t\t\tBUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the\n\t\t\tvalue.

\n

For more information, see Blocking public access to the S3\n\t\t\t\tbucket.

" + "smithy.api#documentation": "

Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.

If no value is specified, the default is PUBLIC_READ.

Note: This default can cause CA creation to fail in some circumstances. If you have have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as BUCKET_OWNER_FULL_CONTROL, and not doing so results in an error. If you have disabled BPA in S3, then you can specify either BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value.

For more information, see Blocking public access to the S3 bucket.

" } }, "CrlDistributionPointExtensionConfiguration": { @@ -2008,18 +2008,18 @@ "CrlType": { "target": "com.amazonaws.acmpca#CrlType", "traits": { - "smithy.api#documentation": "

Specifies whether to create a complete or partitioned CRL. This setting determines the maximum \n\t\tnumber of certificates that the certificate authority can issue and revoke. For more information, see\n\t\tAmazon Web Services Private CA quotas.

\n
    \n
  • \n

    \n COMPLETE - The default setting. Amazon Web Services Private CA maintains a single CRL file for all unexpired \n\t\t\t\tcertificates issued by a CA that have been revoked for any reason. Each certificate that Amazon Web Services Private CA\n\t\t\tissues is bound to a specific CRL through its CRL distribution point (CDP) extension, defined in \n\t\t\t\tRFC 5280.

    \n
    • \n
  • \n

    \n PARTITIONED - Compared to complete CRLs, partitioned CRLs\n\t\t\tdramatically increase the number of certificates your private CA can issue.

    \n \n

    When using partitioned CRLs, you must validate that the CRL's associated\n\t\t\t\t\t\tissuing distribution point (IDP) URI matches the certificate's CDP URI to ensure\n\t\t\t\t\t\tthe right CRL has been fetched. Amazon Web Services Private CA marks the IDP extension as critical, \n\t\t\t\t\t\twhich your client must be able to process.\n\t\t\t\t\t

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

Specifies whether to create a complete or partitioned CRL. This setting determines the maximum number of certificates that the certificate authority can issue and revoke. For more information, see Amazon Web Services Private CA quotas.

  • COMPLETE - The default setting. Amazon Web Services Private CA maintains a single CRL file for all unexpired certificates issued by a CA that have been revoked for any reason. Each certificate that Amazon Web Services Private CA issues is bound to a specific CRL through its CRL distribution point (CDP) extension, defined in RFC 5280.

  • PARTITIONED - Compared to complete CRLs, partitioned CRLs dramatically increase the number of certificates your private CA can issue.

    When using partitioned CRLs, you must validate that the CRL's associated issuing distribution point (IDP) URI matches the certificate's CDP URI to ensure the right CRL has been fetched. Amazon Web Services Private CA marks the IDP extension as critical, which your client must be able to process.

" } }, "CustomPath": { "target": "com.amazonaws.acmpca#CrlPathString", "traits": { - "smithy.api#documentation": "

Designates a custom file path in S3 for CRL(s). For example, http://<CustomName>/\n\t\t\t<CustomPath>/<CrlPartition_GUID>.crl. \n\t\t

" + "smithy.api#documentation": "

Designates a custom file path in S3 for CRL(s). For example, http://<CustomName>/ <CustomPath>/<CrlPartition_GUID>.crl.

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

Contains configuration information for a certificate revocation list (CRL). Your\n\t\t\tprivate certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You\n\t\t\tcan enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA\n\t\t\twrites CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by\n\t\t\tspecifying a value for the CustomCname parameter. Your\n\t\t\tprivate CA by default copies the CNAME or the S3 bucket name to the CRL\n\t\t\t\tDistribution Points extension of each certificate it issues. If you want to configure\n\t\t\t\tthis default behavior to be something different, you can set the CrlDistributionPointExtensionConfiguration \n\t\t\t\tparameter. Your S3\n\t\t\tbucket policy must give write permission to Amazon Web Services Private CA.

\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\n\t\t\tCRLs.

\n

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed prior to a\n\t\t\tcertificate's expiration date or when a certificate is revoked. When a certificate is\n\t\t\trevoked, it appears in the CRL until the certificate expires, and then in one additional\n\t\t\tCRL after expiration, and it always appears in the audit report.

\n

A CRL is typically updated approximately 30 minutes after a certificate \n\tis revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts \n\tevery 15 minutes.

\n

CRLs contain the following fields:

\n
    \n
  • \n

    \n Version: The current version number defined\n\t\t\t\t\tin RFC 5280 is V2. The integer value is 0x1.

    \n
    • \n
  • \n

    \n Signature Algorithm: The name of the\n\t\t\t\t\talgorithm used to sign the CRL.

    \n
    • \n
  • \n

    \n Issuer: The X.500 distinguished name of your\n\t\t\t\t\tprivate CA that issued the CRL.

    \n
    • \n
  • \n

    \n Last Update: The issue date and time of this\n\t\t\t\t\tCRL.

    \n
    • \n
  • \n

    \n Next Update: The day and time by which the\n\t\t\t\t\tnext CRL will be issued.

    \n
    • \n
  • \n

    \n Revoked Certificates: List of revoked\n\t\t\t\t\tcertificates. Each list item contains the following information.

    \n
      \n
    • \n

      \n Serial Number: The serial number, in\n\t\t\t\t\t\t\thexadecimal format, of the revoked certificate.

      \n
      • \n
    • \n

      \n Revocation Date: Date and time the\n\t\t\t\t\t\t\tcertificate was revoked.

      \n
      • \n
    • \n

      \n CRL Entry Extensions: Optional\n\t\t\t\t\t\t\textensions for the CRL entry.

      \n
        \n
      • \n

        \n X509v3 CRL Reason Code:\n\t\t\t\t\t\t\t\t\tReason the certificate was revoked.

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

    \n CRL Extensions: Optional extensions for the\n\t\t\t\t\tCRL.

    \n
      \n
    • \n

      \n X509v3 Authority Key Identifier:\n\t\t\t\t\t\t\tIdentifies the public key associated with the private key used to sign\n\t\t\t\t\t\t\tthe certificate.

      \n
      • \n
    • \n

      \n X509v3 CRL Number:: Decimal sequence\n\t\t\t\t\t\t\tnumber for the CRL.

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

    \n Signature Algorithm: Algorithm used by your\n\t\t\t\t\tprivate CA to sign the CRL.

    \n
    • \n
  • \n

    \n Signature Value: Signature computed over the\n\t\t\t\t\tCRL.

    \n
    • \n
\n

Certificate revocation lists created by Amazon Web Services Private CA are DER-encoded. You can use the\n\t\t\tfollowing OpenSSL command to list a CRL.

\n

\n openssl crl -inform DER -text -in crl_path\n\t\t\t-noout\n

\n

For more information, see Planning a certificate revocation list\n\t\t\t\t(CRL) in the Amazon Web Services Private Certificate Authority User Guide\n

" + "smithy.api#documentation": "

Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA by default copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. If you want to configure this default behavior to be something different, you can set the CrlDistributionPointExtensionConfiguration parameter. Your S3 bucket policy must give write permission to Amazon Web Services Private CA.

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

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed prior to a certificate's expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.

A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.

CRLs contain the following fields:

  • Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1.

  • Signature Algorithm: The name of the algorithm used to sign the CRL.

  • Issuer: The X.500 distinguished name of your private CA that issued the CRL.

  • Last Update: The issue date and time of this CRL.

  • Next Update: The day and time by which the next CRL will be issued.

  • Revoked Certificates: List of revoked certificates. Each list item contains the following information.

    • Serial Number: The serial number, in hexadecimal format, of the revoked certificate.

    • Revocation Date: Date and time the certificate was revoked.

    • CRL Entry Extensions: Optional extensions for the CRL entry.

      • X509v3 CRL Reason Code: Reason the certificate was revoked.

  • CRL Extensions: Optional extensions for the CRL.

    • X509v3 Authority Key Identifier: Identifies the public key associated with the private key used to sign the certificate.

    • X509v3 CRL Number:: Decimal sequence number for the CRL.

  • Signature Algorithm: Algorithm used by your private CA to sign the CRL.

  • Signature Value: Signature computed over the CRL.

Certificate revocation lists created by Amazon Web Services Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.

openssl crl -inform DER -text -in crl_path -noout

For more information, see Planning a certificate revocation list (CRL) in the Amazon Web Services Private Certificate Authority User Guide

" } }, "com.amazonaws.acmpca#CrlDistributionPointExtensionConfiguration": { @@ -2029,13 +2029,13 @@ "target": "com.amazonaws.acmpca#Boolean", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to true, then the CDP extension will\n\t\t\tnot be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough.

\n \n

Only set this if you have another way to distribute the CRL Distribution Points ffor certificates issued by your CA, such as the Matter Distributed Compliance Ledger

\n

This configuration cannot be enabled with a custom CNAME set.

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

Configures whether the CRL Distribution Point extension should be populated with the default URL to the CRL. If set to true, then the CDP extension will not be present in any certificates issued by that CA unless otherwise specified through CSR or API passthrough.

Only set this if you have another way to distribute the CRL Distribution Points ffor certificates issued by your CA, such as the Matter Distributed Compliance Ledger

This configuration cannot be enabled with a custom CNAME set.

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

Contains configuration information for the default behavior of the CRL Distribution Point (CDP) extension in certificates issued by your CA. This extension \n\t\t\tcontains a link to download the CRL, so you can check whether a certificate has been revoked. To choose whether you want this extension\n\t\t\tomitted or not in certificates issued by your CA, you can set the OmitExtension parameter.

" + "smithy.api#documentation": "

Contains configuration information for the default behavior of the CRL Distribution Point (CDP) extension in certificates issued by your CA. This extension contains a link to download the CRL, so you can check whether a certificate has been revoked. To choose whether you want this extension omitted or not in certificates issued by your CA, you can set the OmitExtension parameter.

" } }, "com.amazonaws.acmpca#CrlPathString": { @@ -2083,18 +2083,18 @@ "KeyUsage": { "target": "com.amazonaws.acmpca#KeyUsage", "traits": { - "smithy.api#documentation": "

Indicates the purpose of the certificate and of the key contained in the\n\t\t\tcertificate.

" + "smithy.api#documentation": "

Indicates the purpose of the certificate and of the key contained in the certificate.

" } }, "SubjectInformationAccess": { "target": "com.amazonaws.acmpca#AccessDescriptionList", "traits": { - "smithy.api#documentation": "

For CA certificates, provides a path to additional information pertaining to the CA,\n\t\t\tsuch as revocation and policy. For more information, see Subject\n\t\t\t\tInformation Access in RFC 5280.

" + "smithy.api#documentation": "

For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy. For more information, see Subject Information Access in RFC 5280.

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

Describes the certificate extensions to be added to the certificate signing request\n\t\t\t(CSR).

" + "smithy.api#documentation": "

Describes the certificate extensions to be added to the certificate signing request (CSR).

" } }, "com.amazonaws.acmpca#CustomAttribute": { @@ -2103,14 +2103,14 @@ "ObjectIdentifier": { "target": "com.amazonaws.acmpca#CustomObjectIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the object identifier (OID) of the attribute type of the relative\n\t\t\tdistinguished name (RDN).

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

Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.acmpca#String1To256", "traits": { - "smithy.api#documentation": "

\n

Specifies the attribute value of relative distinguished name (RDN).

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

Specifies the attribute value of relative distinguished name (RDN).

", "smithy.api#required": {} } } @@ -2137,14 +2137,14 @@ "ObjectIdentifier": { "target": "com.amazonaws.acmpca#CustomObjectIdentifier", "traits": { - "smithy.api#documentation": "

\n

Specifies the object identifier (OID) of the X.509 extension. For more information,\n\t\t\tsee the Global OID reference database.\n

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

Specifies the object identifier (OID) of the X.509 extension. For more information, see the Global OID reference database.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.acmpca#Base64String1To4096", "traits": { - "smithy.api#documentation": "

\n

Specifies the base64-encoded value of the X.509 extension.

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

Specifies the base64-encoded value of the X.509 extension.

", "smithy.api#required": {} } }, @@ -2152,12 +2152,12 @@ "target": "com.amazonaws.acmpca#Boolean", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

\n

Specifies the critical flag of the X.509 extension.

" + "smithy.api#documentation": "

Specifies the critical flag of the X.509 extension.

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

\n

Specifies the X.509 extension information for a certificate.

\n

Extensions present in CustomExtensions follow the\n\t\t\t\tApiPassthrough\n template\n\t\t\t\trules.

" + "smithy.api#documentation": "

Specifies the X.509 extension information for a certificate.

Extensions present in CustomExtensions follow the ApiPassthrough template rules.

" } }, "com.amazonaws.acmpca#CustomExtensionList": { @@ -2205,7 +2205,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a private certificate authority (CA). You must provide the Amazon Resource\n\t\t\tName (ARN) of the private CA that you want to delete. You can find the ARN by calling\n\t\t\tthe ListCertificateAuthorities action.

\n \n

Deleting a CA will invalidate other CAs and certificates below it in your CA\n\t\t\t\thierarchy.

\n \n

Before you can delete a CA that you have created and activated, you must disable it.\n\t\t\tTo do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

\n

Additionally, you can delete a CA if you are waiting for it to be created (that is,\n\t\t\tthe status of the CA is CREATING). You can also delete it if the CA has\n\t\t\tbeen created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that\n\t\t\tis, the status of the CA is PENDING_CERTIFICATE).

\n

When you successfully call DeleteCertificateAuthority, the CA's status changes to\n\t\t\tDELETED. However, the CA won't be permanently deleted until the restoration\n\t\t\tperiod has passed. By default, if you do not set the\n\t\t\t\tPermanentDeletionTimeInDays parameter, the CA remains restorable for 30\n\t\t\tdays. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the\n\t\t\trestoration window of a private CA in the DELETED state. To restore an\n\t\t\teligible CA, call the RestoreCertificateAuthority action.

" + "smithy.api#documentation": "

Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action.

Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.

Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that is, the status of the CA is PENDING_CERTIFICATE).

When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action.

A private CA can be deleted if it is in the PENDING_CERTIFICATE, CREATING, EXPIRED, DISABLED, or FAILED state. To delete a CA in the ACTIVE state, you must first disable it, or else the delete request results in an exception. If you are deleting a private CA in the PENDING_CERTIFICATE or DISABLED state, you can set the length of its restoration period to 7-30 days. The default is 30. During this time, the status is set to DELETED and the CA can be restored. A private CA deleted in the CREATING or FAILED state has no assigned restoration period and cannot be restored.

" } }, "com.amazonaws.acmpca#DeleteCertificateAuthorityRequest": { @@ -2214,14 +2214,14 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

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

The number of days to make a CA restorable after it has been deleted. This can be\n\t\t\tanywhere from 7 to 30 days, with 30 being the default.

" + "smithy.api#documentation": "

The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default.

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

Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal\n\t\t\t(acm.amazonaws.com).

\n

These permissions allow ACM to issue and renew ACM certificates that reside in the\n\t\t\tsame Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer\n\t\t\trenew the affected certificates automatically.

\n

Permissions can be granted with the CreatePermission action and\n\t\t\tlisted with the ListPermissions action.

\n

\n About Permissions\n

\n
    \n
  • \n

    If the private CA and the certificates it issues reside in the same \n\t\t\taccount, you can use CreatePermission to grant permissions for ACM to \n\t\t\tcarry out automatic certificate renewals.

    \n
    • \n
  • \n

    For automatic certificate renewal to succeed, the ACM service principal\n\t\t\tneeds permissions to create, retrieve, and list certificates.

    \n
    • \n
  • \n

    If the private CA and the ACM certificates reside in different accounts, \n\t\t\tthen permissions cannot be used to enable automatic renewals. Instead, \n\t\t\tthe ACM certificate owner must set up a resource-based policy to enable \n\t\t\tcross-account issuance and renewals. For more information, see \n\t\t\tUsing a Resource\n\t\t\tBased Policy with Amazon Web Services Private CA.

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

Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.

Permissions can be granted with the CreatePermission action and listed with the ListPermissions action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.

" } }, "com.amazonaws.acmpca#DeletePermissionRequest": { @@ -2261,14 +2261,14 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the private CA that issued the permissions. You\n\t\t\tcan find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

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

The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

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

The Amazon Web Services service or identity that will have its CA permissions revoked. At this time,\n\t\t\tthe only valid service principal is acm.amazonaws.com\n

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

The Amazon Web Services service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com

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

Deletes the resource-based policy attached to a private CA. Deletion will remove any\n\t\t\taccess that the policy has granted. If there is no policy attached to the private CA,\n\t\t\tthis action will return successful.

\n

If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM),\n\t\t\tthe CA will be removed from all shares in which it was included.

\n

The Certificate Manager Service Linked Role that the policy supports is not affected when you\n\t\t\tdelete the policy.

\n

The current policy can be shown with GetPolicy and updated with PutPolicy.

\n

\n About Policies\n

\n
    \n
  • \n

    A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to\n\t\t\tan Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, \n\t\t\tsee Using a Resource Based Policy with Amazon Web Services Private CA.

    \n
    • \n
  • \n

    A policy permits a user of Certificate Manager (ACM) to issue ACM certificates \n\t\t\tsigned by a CA in another account.

    \n
    • \n
  • \n

    For ACM to manage automatic renewal of these certificates, \n\t\t\tthe ACM user must configure a Service Linked Role (SLR). The SLR allows \n\t\t\tthe ACM service to assume the identity of the user, subject to confirmation against the \n\t\t\tAmazon Web Services Private CA policy. For more information, see \n\t\t\tUsing a\n Service Linked Role with ACM.

    \n
    • \n
  • \n

    Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,\n\t\t\tsee Attach a Policy for Cross-Account \n\t\t\tAccess.

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

Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.

If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.

The current policy can be shown with GetPolicy and updated with PutPolicy.

About Policies

  • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.

  • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

  • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.

  • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

" } }, "com.amazonaws.acmpca#DeletePolicyRequest": { @@ -2321,7 +2321,7 @@ "ResourceArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the private CA that will have its policy deleted.\n\t\t\tYou can find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form\n\t\t\t\tarn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab.\n\t\t

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

The Amazon Resource Number (ARN) of the private CA that will have its policy deleted. You can find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab.

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

Lists information about your private certificate authority (CA) or one that has been\n\t\t\tshared with you. You specify the private CA on input by its ARN (Amazon Resource Name).\n\t\t\tThe output contains the status of your CA. This can be any of the following:

\n
    \n
  • \n

    \n CREATING - Amazon Web Services Private CA is creating your private certificate\n\t\t\t\t\tauthority.

    \n
    • \n
  • \n

    \n PENDING_CERTIFICATE - The certificate is pending. You must use\n\t\t\t\t\tyour Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your\n\t\t\t\t\tprivate CA CSR and then import it into Amazon Web Services Private CA.

    \n
    • \n
  • \n

    \n ACTIVE - Your private CA is active.

    \n
    • \n
  • \n

    \n DISABLED - Your private CA has been disabled.

    \n
    • \n
  • \n

    \n EXPIRED - Your private CA certificate has expired.

    \n
    • \n
  • \n

    \n FAILED - Your private CA has failed. Your CA can fail because of\n\t\t\t\t\tproblems such a network outage or back-end Amazon Web Services failure or other errors. A\n\t\t\t\t\tfailed CA can never return to the pending state. You must create a new CA.\n\t\t\t\t

    \n
    • \n
  • \n

    \n DELETED - Your private CA is within the restoration period, after\n\t\t\t\t\twhich it is permanently deleted. The length of time remaining in the CA's\n\t\t\t\t\trestoration period is also included in this action's output.

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

Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:

  • CREATING - Amazon Web Services Private CA is creating your private certificate authority.

  • PENDING_CERTIFICATE - The certificate is pending. You must use your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into Amazon Web Services Private CA.

  • ACTIVE - Your private CA is active.

  • DISABLED - Your private CA has been disabled.

  • EXPIRED - Your private CA certificate has expired.

  • FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or back-end Amazon Web Services failure or other errors. A failed CA can never return to the pending state. You must create a new CA.

  • DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.

" } }, "com.amazonaws.acmpca#DescribeCertificateAuthorityAuditReport": { @@ -2370,7 +2370,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created\n\t\t\tevery time the certificate authority (CA) private key is used. The private key is used\n\t\t\twhen you call the IssueCertificate action or the\n\t\t\t\tRevokeCertificate action.

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

Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.

", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -2417,7 +2417,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the private CA. This must be of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

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

The Amazon Resource Name (ARN) of the private CA. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

", "smithy.api#required": {} } }, @@ -2451,7 +2451,7 @@ "S3Key": { "target": "com.amazonaws.acmpca#S3Key", "traits": { - "smithy.api#documentation": "

S3 key that uniquely identifies the report file in\n\t\t\tyour S3 bucket.

" + "smithy.api#documentation": "

S3 key that uniquely identifies the report file in your S3 bucket.

" } }, "CreatedAt": { @@ -2471,7 +2471,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

", "smithy.api#required": {} } } @@ -2486,7 +2486,7 @@ "CertificateAuthority": { "target": "com.amazonaws.acmpca#CertificateAuthority", "traits": { - "smithy.api#documentation": "

A CertificateAuthority structure that contains information about your private\n\t\t\tCA.

" + "smithy.api#documentation": "

A CertificateAuthority structure that contains information about your private CA.

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

Describes an Electronic Data Interchange (EDI) entity as described in as defined in\n\t\t\t\tSubject Alternative\n\t\t\t\tName in RFC 5280.

" + "smithy.api#documentation": "

Describes an Electronic Data Interchange (EDI) entity as described in as defined in Subject Alternative Name in RFC 5280.

" } }, "com.amazonaws.acmpca#ExtendedKeyUsage": { @@ -2521,18 +2521,18 @@ "ExtendedKeyUsageType": { "target": "com.amazonaws.acmpca#ExtendedKeyUsageType", "traits": { - "smithy.api#documentation": "

Specifies a standard ExtendedKeyUsage as defined as in RFC\n\t\t\t\t5280.

" + "smithy.api#documentation": "

Specifies a standard ExtendedKeyUsage as defined as in RFC 5280.

" } }, "ExtendedKeyUsageObjectIdentifier": { "target": "com.amazonaws.acmpca#CustomObjectIdentifier", "traits": { - "smithy.api#documentation": "

Specifies a custom ExtendedKeyUsage with an object identifier\n\t\t\t(OID).

" + "smithy.api#documentation": "

Specifies a custom ExtendedKeyUsage with an object identifier (OID).

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

Specifies additional purposes for which the certified public key may be used other\n\t\t\tthan basic purposes indicated in the KeyUsage extension.

" + "smithy.api#documentation": "

Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.

" } }, "com.amazonaws.acmpca#ExtendedKeyUsageList": { @@ -2612,13 +2612,13 @@ "CertificatePolicies": { "target": "com.amazonaws.acmpca#CertificatePolicyList", "traits": { - "smithy.api#documentation": "

Contains a sequence of one or more policy information terms, each of which consists of\n\t\t\tan object identifier (OID) and optional qualifiers. For more information, see NIST's\n\t\t\tdefinition of Object\n\t\t\t\tIdentifier (OID).

\n

In an end-entity certificate, these terms indicate the policy under which the\n\t\t\tcertificate was issued and the purposes for which it may be used. In a CA certificate,\n\t\t\tthese terms limit the set of policies for certification paths that include this\n\t\t\tcertificate.

" + "smithy.api#documentation": "

Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST's definition of Object Identifier (OID).

In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.

" } }, "ExtendedKeyUsage": { "target": "com.amazonaws.acmpca#ExtendedKeyUsageList", "traits": { - "smithy.api#documentation": "

Specifies additional purposes for which the certified public key may be used other\n\t\t\tthan basic purposes indicated in the KeyUsage extension.

" + "smithy.api#documentation": "

Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.

" } }, "KeyUsage": { @@ -2627,13 +2627,13 @@ "SubjectAlternativeNames": { "target": "com.amazonaws.acmpca#GeneralNameList", "traits": { - "smithy.api#documentation": "

The subject alternative name extension allows identities to be bound to the subject of\n\t\t\tthe certificate. These identities may be included in addition to or in place of the\n\t\t\tidentity in the subject field of the certificate.

" + "smithy.api#documentation": "

The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate.

" } }, "CustomExtensions": { "target": "com.amazonaws.acmpca#CustomExtensionList", "traits": { - "smithy.api#documentation": "

\n

Contains a sequence of one or more X.509 extensions, each of which consists of an\n\t\t\tobject identifier (OID), a base64-encoded value, and the critical flag. For more\n\t\t\tinformation, see the Global OID reference\n\t\t\t\tdatabase.\n

" + "smithy.api#documentation": "

Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the Global OID reference database.

" } } }, @@ -2676,7 +2676,7 @@ "Rfc822Name": { "target": "com.amazonaws.acmpca#String256", "traits": { - "smithy.api#documentation": "

Represents GeneralName as an RFC 822 email\n\t\t\taddress.

" + "smithy.api#documentation": "

Represents GeneralName as an RFC 822 email address.

" } }, "DnsName": { @@ -2714,7 +2714,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an ASN.1 X.400 GeneralName as defined in RFC 5280. Only one of\n\t\t\tthe following naming options should be provided. Providing more than one option results\n\t\t\tin an InvalidArgsException error.

" + "smithy.api#documentation": "

Describes an ASN.1 X.400 GeneralName as defined in RFC 5280. Only one of the following naming options should be provided. Providing more than one option results in an InvalidArgsException error.

" } }, "com.amazonaws.acmpca#GeneralNameList": { @@ -2755,7 +2755,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a certificate from your private CA or one that has been shared with you. The\n\t\t\tARN of the certificate is returned when you call the IssueCertificate action. You\n\t\t\tmust specify both the ARN of your private CA and the ARN of the issued certificate when\n\t\t\tcalling the GetCertificate action. You can retrieve the\n\t\t\tcertificate if it is in the ISSUED state. You can call\n\t\t\tthe CreateCertificateAuthorityAuditReport action to create a report that\n\t\t\tcontains information about all of the certificates issued and revoked by your private\n\t\t\tCA.

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

Retrieves a certificate from your private CA or one that has been shared with you. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED, EXPIRED, or REVOKED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA.

", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -2808,7 +2808,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the certificate and certificate chain for your private certificate authority\n\t\t\t(CA) or one that has been shared with you. Both the certificate and the chain are base64\n\t\t\tPEM-encoded. The chain does not include the CA certificate. Each certificate in the\n\t\t\tchain signs the one before it.

" + "smithy.api#documentation": "

Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.

" } }, "com.amazonaws.acmpca#GetCertificateAuthorityCertificateRequest": { @@ -2817,7 +2817,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of your private CA. This is of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

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

The Amazon Resource Name (ARN) of your private CA. This is of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

", "smithy.api#required": {} } } @@ -2838,7 +2838,7 @@ "CertificateChain": { "target": "com.amazonaws.acmpca#CertificateChain", "traits": { - "smithy.api#documentation": "

Base64-encoded certificate chain that includes any intermediate certificates and\n\t\t\tchains up to root certificate that you used to sign your private CA certificate. The\n\t\t\tchain does not include your private CA certificate. If this is a root CA, the value will\n\t\t\tbe null.

" + "smithy.api#documentation": "

Base64-encoded certificate chain that includes any intermediate certificates and chains up to root certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate. If this is a root CA, the value will be null.

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

Retrieves the certificate signing request (CSR) for your private certificate authority\n\t\t\t(CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your Amazon Web Services Private CA-hosted\n\t\t\tor on-premises root or subordinate CA. Then import the signed certificate back into\n\t\t\tAmazon Web Services Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a\n\t\t\tbase64 PEM-encoded string.

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

Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into Amazon Web Services Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.

", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -2911,7 +2911,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n

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

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

", "smithy.api#required": {} } } @@ -2926,7 +2926,7 @@ "Csr": { "target": "com.amazonaws.acmpca#CsrBody", "traits": { - "smithy.api#documentation": "

The base64 PEM-encoded certificate signing request (CSR) for your private CA\n\t\t\tcertificate.

" + "smithy.api#documentation": "

The base64 PEM-encoded certificate signing request (CSR) for your private CA certificate.

" } } }, @@ -2940,14 +2940,14 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

", "smithy.api#required": {} } }, "CertificateArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the issued certificate. The ARN contains the certificate serial number and\n\t\t\tmust be in the following form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245\n \n

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

The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245

", "smithy.api#required": {} } } @@ -2962,13 +2962,13 @@ "Certificate": { "target": "com.amazonaws.acmpca#CertificateBody", "traits": { - "smithy.api#documentation": "

The base64 PEM-encoded certificate specified by the CertificateArn\n\t\t\tparameter.

" + "smithy.api#documentation": "

The base64 PEM-encoded certificate specified by the CertificateArn parameter.

" } }, "CertificateChain": { "target": "com.amazonaws.acmpca#CertificateChain", "traits": { - "smithy.api#documentation": "

The base64 PEM-encoded certificate chain that chains up to the root CA certificate\n\t\t\tthat you used to sign your private CA certificate.

" + "smithy.api#documentation": "

The base64 PEM-encoded certificate chain that chains up to the root CA certificate that you used to sign your private CA certificate.

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

Retrieves the resource-based policy attached to a private CA. If either the private CA\n\t\t\tresource or the policy cannot be found, this action returns a\n\t\t\t\tResourceNotFoundException.

\n

The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

\n

\n About Policies\n

\n
    \n
  • \n

    A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to\n\t\t\tan Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, \n\t\t\tsee Using a Resource Based Policy with Amazon Web Services Private CA.

    \n
    • \n
  • \n

    A policy permits a user of Certificate Manager (ACM) to issue ACM certificates \n\t\t\tsigned by a CA in another account.

    \n
    • \n
  • \n

    For ACM to manage automatic renewal of these certificates, \n\t\t\tthe ACM user must configure a Service Linked Role (SLR). The SLR allows \n\t\t\tthe ACM service to assume the identity of the user, subject to confirmation against the \n\t\t\tAmazon Web Services Private CA policy. For more information, see \n\t\t\tUsing a\n Service Linked Role with ACM.

    \n
    • \n
  • \n

    Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,\n\t\t\tsee Attach a Policy for Cross-Account \n\t\t\tAccess.

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

Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException.

The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

About Policies

  • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.

  • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

  • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.

  • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

" } }, "com.amazonaws.acmpca#GetPolicyRequest": { @@ -3008,7 +3008,7 @@ "ResourceArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the private CA that will have its policy\n\t\t\tretrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.\n\t\t\t\n\t\t

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

The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.

", "smithy.api#required": {} } } @@ -3079,7 +3079,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

    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.

" + "smithy.api#documentation": "

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

  1. In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you plan to back with the imported certificate.

  2. Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).

  3. Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.

  4. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.

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

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

  • Installing a subordinate CA certificate whose parent authority is hosted by Amazon Web Services Private CA.

  • Installing a subordinate CA certificate whose parent authority is externally hosted.

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

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

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

  • Your certificate chain must not include the private CA certificate that you are importing.

  • Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.

  • The chain must be PEM-encoded.

  • The maximum allowed size of a certificate is 32 KB.

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

Enforcement of Critical Constraints

Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.

  • Authority key identifier

  • Basic constraints (must be marked critical)

  • Certificate policies

  • Extended key usage

  • Inhibit anyPolicy

  • Issuer alternative name

  • Key usage

  • Name constraints

  • Policy mappings

  • Subject alternative name

  • Subject directory attributes

  • Subject key identifier

  • Subject information access

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

  • Authority information access

  • CRL distribution points

  • Freshest CRL

  • Policy constraints

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": { @@ -3088,21 +3088,21 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

", "smithy.api#required": {} } }, "Certificate": { "target": "com.amazonaws.acmpca#CertificateBodyBlob", "traits": { - "smithy.api#documentation": "

The PEM-encoded certificate for a private CA. This may be a self-signed certificate in\n\t\t\tthe case of a root CA, or it may be signed by another CA that you control.

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

The PEM-encoded certificate for a private CA. This may be a self-signed certificate in the case of a root CA, or it may be signed by another CA that you control.

", "smithy.api#required": {} } }, "CertificateChain": { "target": "com.amazonaws.acmpca#CertificateChainBlob", "traits": { - "smithy.api#documentation": "

A PEM-encoded file that contains all of your certificates, other than the certificate\n\t\t\tyou're importing, chaining up to your root CA. Your Amazon Web Services Private CA-hosted or on-premises\n\t\t\troot certificate is the last in the chain, and each certificate in the chain signs the\n\t\t\tone preceding.

\n

This parameter must be supplied when you import a subordinate CA. When you import a\n\t\t\troot CA, there is no chain.

" + "smithy.api#documentation": "

A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your Amazon Web Services Private CA-hosted or on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding.

This parameter must be supplied when you import a subordinate CA. When you import a root CA, there is no chain.

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

The requested Amazon Resource Name (ARN) does not refer to an existing\n\t\t\tresource.

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

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

", "smithy.api#error": "client" } }, @@ -3151,7 +3151,7 @@ } }, "traits": { - "smithy.api#documentation": "

The token specified in the NextToken argument is not valid. Use the token\n\t\t\treturned from your previous call to ListCertificateAuthorities.

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

The token specified in the NextToken argument is not valid. Use the token returned from your previous call to ListCertificateAuthorities.

", "smithy.api#error": "client" } }, @@ -3163,7 +3163,7 @@ } }, "traits": { - "smithy.api#documentation": "

The resource policy is invalid or is missing a required statement. For general\n\t\t\tinformation about IAM policy and statement structure, see Overview of JSON Policies.

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

The resource policy is invalid or is missing a required statement. For general information about IAM policy and statement structure, see Overview of JSON Policies.

", "smithy.api#error": "client" } }, @@ -3199,7 +3199,7 @@ } }, "traits": { - "smithy.api#documentation": "

The tag associated with the CA is not valid. The invalid argument is contained in the\n\t\t\tmessage field.

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

The tag associated with the CA is not valid. The invalid argument is contained in the message field.

", "smithy.api#error": "client" } }, @@ -3232,7 +3232,7 @@ } ], "traits": { - "smithy.api#documentation": "

Uses your private certificate authority (CA), or one that has been shared with you, to\n\t\t\tissue a client certificate. This action returns the Amazon Resource Name (ARN) of the\n\t\t\tcertificate. You can retrieve the certificate by calling the GetCertificate action and\n\t\t\tspecifying the ARN.

\n \n

You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the\n\t\t\t\tcertificates that you issue by using Amazon Web Services Private CA.

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

Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.

You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using Amazon Web Services Private CA.

", "smithy.api#idempotent": {} } }, @@ -3242,53 +3242,53 @@ "ApiPassthrough": { "target": "com.amazonaws.acmpca#ApiPassthrough", "traits": { - "smithy.api#documentation": "

Specifies X.509 certificate information to be included in the issued certificate. An\n\t\t\t\tAPIPassthrough or APICSRPassthrough template variant must\n\t\t\tbe selected, or else this parameter is ignored. For more information about using these\n\t\t\ttemplates, see Understanding Certificate Templates.

\n

If conflicting or duplicate certificate information is supplied during certificate\n\t\t\tissuance, Amazon Web Services Private CA applies order of\n\t\t\t\toperation rules to determine what information is used.

" + "smithy.api#documentation": "

Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored. For more information about using these templates, see Understanding Certificate Templates.

If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies order of operation rules to determine what information is used.

" } }, "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

", "smithy.api#required": {} } }, "Csr": { "target": "com.amazonaws.acmpca#CsrBlob", "traits": { - "smithy.api#documentation": "

The certificate signing request (CSR) for the certificate you want to issue. As an\n\t\t\texample, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA\n\t\t\tprivate key.

\n

\n openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem\n\t\t\t\t-out csr/test_cert_.csr\n

\n

If you have a configuration file, you can then use the following OpenSSL command. The\n\t\t\t\tusr_cert block in the configuration file contains your X509 version 3\n\t\t\textensions.

\n

\n openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048\n\t\t\t\t-days 365 -keyout private/test_cert_priv_key.pem -out\n\t\t\tcsr/test_cert_.csr\n

\n

Note: A CSR must provide either a subject name or a\n\t\t\t\tsubject alternative name or the request will be rejected.\n\t\t

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

The certificate signing request (CSR) for the certificate you want to issue. As an example, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

If you have a configuration file, you can then use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.

openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.

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

The name of the algorithm that will be used to sign the certificate to be issued.

\n

This parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign a CSR in the CreateCertificateAuthority action.

\n \n

The specified signing algorithm family (RSA or ECDSA) must match the algorithm\n\t\t\t\tfamily of the CA's secret key.

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

The name of the algorithm that will be used to sign the certificate to be issued.

This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR in the CreateCertificateAuthority action.

The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

", "smithy.api#required": {} } }, "TemplateArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

Specifies a custom configuration template to use when issuing a certificate. If this\n\t\t\tparameter is not provided, Amazon Web Services Private CA defaults to the\n\t\t\t\tEndEntityCertificate/V1 template. For CA certificates, you should\n\t\t\tchoose the shortest path length that meets your needs. The path length is indicated by\n\t\t\tthe PathLenN portion of the ARN, where N is\n\t\t\tthe CA\n\t\t\t\tdepth.

\n

Note: The CA depth configured on a subordinate CA certificate must not exceed the\n\t\t\tlimit set by its parents in the CA hierarchy.

\n

For a list of TemplateArn values supported by Amazon Web Services Private CA, see Understanding Certificate\n\t\t\t\tTemplates.

" + "smithy.api#documentation": "

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, Amazon Web Services Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.

Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.

For a list of TemplateArn values supported by Amazon Web Services Private CA, see Understanding Certificate Templates.

" } }, "Validity": { "target": "com.amazonaws.acmpca#Validity", "traits": { - "smithy.api#documentation": "

Information describing the end of the validity period of the certificate. This\n\t\t\tparameter sets the “Not After” date for the certificate.

\n

Certificate validity is the period of time during which a certificate is valid.\n\t\t\tValidity can be expressed as an explicit date and time when the certificate expires, or\n\t\t\tas a span of time after issuance, stated in days, months, or years. For more\n\t\t\tinformation, see Validity\n\t\t\tin RFC 5280.

\n

This value is unaffected when ValidityNotBefore is also specified. For\n\t\t\texample, if Validity is set to 20 days in the future, the certificate will\n\t\t\texpire 20 days from issuance time regardless of the ValidityNotBefore\n\t\t\tvalue.

\n

The end of the validity period configured on a certificate must not exceed the limit\n\t\t\tset on its parents in the CA hierarchy.

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

Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.

Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.

This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.

The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.

", "smithy.api#required": {} } }, "ValidityNotBefore": { "target": "com.amazonaws.acmpca#Validity", "traits": { - "smithy.api#documentation": "

Information describing the start of the validity period of the certificate. This\n\t\t\tparameter sets the “Not Before\" date for the certificate.

\n

By default, when issuing a certificate, Amazon Web Services Private CA sets the \"Not Before\" date to the\n\t\t\tissuance time minus 60 minutes. This compensates for clock inconsistencies across\n\t\t\tcomputer systems. The ValidityNotBefore parameter can be used to customize\n\t\t\tthe “Not Before” value.

\n

Unlike the Validity parameter, the ValidityNotBefore\n\t\t\tparameter is optional.

\n

The ValidityNotBefore value is expressed as an explicit date and time,\n\t\t\tusing the Validity type value ABSOLUTE. For more information,\n\t\t\tsee Validity in\n\t\t\tthis API reference and Validity\n\t\t\tin RFC 5280.

" + "smithy.api#documentation": "

Information describing the start of the validity period of the certificate. This parameter sets the “Not Before\" date for the certificate.

By default, when issuing a certificate, Amazon Web Services Private CA sets the \"Not Before\" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value.

Unlike the Validity parameter, the ValidityNotBefore parameter is optional.

The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE. For more information, see Validity in this API reference and Validity in RFC 5280.

" } }, "IdempotencyToken": { "target": "com.amazonaws.acmpca#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after five minutes. Therefore, if\n\t\t\tyou call IssueCertificate multiple times with the same\n\t\t\tidempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting\n\t\t\tonly one certificate and will issue only one. If you change the idempotency token for\n\t\t\teach call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.

" + "smithy.api#documentation": "

Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after five minutes. Therefore, if you call IssueCertificate multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.

" } } }, @@ -3302,7 +3302,7 @@ "CertificateArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the issued certificate and the certificate serial\n\t\t\tnumber. This is of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245\n \n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245

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

Defines one or more purposes for which the key contained in the certificate can be\n\t\t\tused. Default value for each option is false.

" + "smithy.api#documentation": "

Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.

" } }, "com.amazonaws.acmpca#LimitExceededException": { @@ -3459,7 +3459,7 @@ } }, "traits": { - "smithy.api#documentation": "

An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine\n\t\t\tthe quota that was exceeded.

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

An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.

", "smithy.api#error": "client" } }, @@ -3492,19 +3492,19 @@ "MaxResults": { "target": "com.amazonaws.acmpca#MaxResults", "traits": { - "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to\n\t\t\treturn in the response on each page. If additional items exist beyond the number you\n\t\t\tspecify, the NextToken element is sent in the response. Use this\n\t\t\t\tNextToken value in a subsequent request to retrieve additional\n\t\t\titems.

\n

Although the maximum value is 1000, the action only returns a maximum of 100 items.

" + "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

Although the maximum value is 1000, the action only returns a maximum of 100 items.

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

Use this parameter when paginating results in a subsequent request after you receive a\n\t\t\tresponse with truncated results. Set it to the value of the NextToken\n\t\t\tparameter from the response you just received.

" + "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.

" } }, "ResourceOwner": { "target": "com.amazonaws.acmpca#ResourceOwner", "traits": { - "smithy.api#documentation": "

Use this parameter to filter the returned set of certificate authorities based on\n\t\t\ttheir owner. The default is SELF.

" + "smithy.api#documentation": "

Use this parameter to filter the returned set of certificate authorities based on their owner. The default is SELF.

" } } }, @@ -3518,7 +3518,7 @@ "NextToken": { "target": "com.amazonaws.acmpca#NextToken", "traits": { - "smithy.api#documentation": "

When the list is truncated, this value is present and should be used for the\n\t\t\t\tNextToken parameter in a subsequent pagination request.

" + "smithy.api#documentation": "

When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.

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

List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service\n\t\t\tprincipal (acm.amazonaws.com).

\n

These permissions allow ACM to issue and renew ACM certificates that reside in the\n\t\t\tsame Amazon Web Services account as the CA.

\n

Permissions can be granted with the CreatePermission action and\n\t\t\trevoked with the DeletePermission action.

\n

\n About Permissions\n

\n
    \n
  • \n

    If the private CA and the certificates it issues reside in the same \n\t\t\taccount, you can use CreatePermission to grant permissions for ACM to \n\t\t\tcarry out automatic certificate renewals.

    \n
    • \n
  • \n

    For automatic certificate renewal to succeed, the ACM service principal\n\t\t\tneeds permissions to create, retrieve, and list certificates.

    \n
    • \n
  • \n

    If the private CA and the ACM certificates reside in different accounts, \n\t\t\tthen permissions cannot be used to enable automatic renewals. Instead, \n\t\t\tthe ACM certificate owner must set up a resource-based policy to enable \n\t\t\tcross-account issuance and renewals. For more information, see \n\t\t\tUsing a Resource\n\t\t\tBased Policy with Amazon Web Services Private CA.

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

List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).

These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.

Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3573,19 +3573,19 @@ "MaxResults": { "target": "com.amazonaws.acmpca#MaxResults", "traits": { - "smithy.api#documentation": "

When paginating results, use this parameter to specify the maximum number of items to\n\t\t\treturn in the response. If additional items exist beyond the number you specify, the\n\t\t\t\tNextToken element is sent in the response. Use this\n\t\t\t\tNextToken value in a subsequent request to retrieve\n\t\t\tadditional items.

" + "smithy.api#documentation": "

When paginating results, use this parameter to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

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

When paginating results, use this parameter in a subsequent request after you receive\n\t\t\ta response with truncated results. Set it to the value of NextToken from the response you just received.

" + "smithy.api#documentation": "

When paginating results, use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

" } }, "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by\n\t\t\tcalling the ListCertificateAuthorities action. This must be of the form:\n\t\t\t\tarn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n\t\t\tYou can get a private CA's ARN by running the ListCertificateAuthorities action.

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

The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities action.

", "smithy.api#required": {} } } @@ -3600,13 +3600,13 @@ "NextToken": { "target": "com.amazonaws.acmpca#NextToken", "traits": { - "smithy.api#documentation": "

When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.\n\t\t

" + "smithy.api#documentation": "

When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.

" } }, "Permissions": { "target": "com.amazonaws.acmpca#PermissionList", "traits": { - "smithy.api#documentation": "

Summary information about each permission assigned by the specified private CA,\n\t\t\tincluding the action enabled, the policy provided, and the time of creation.

" + "smithy.api#documentation": "

Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation.

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

Lists the tags, if any, that are associated with your private CA or one that has been\n\t\t\tshared with you. Tags are labels that you can use to identify and organize your CAs.\n\t\t\tEach tag consists of a key and an optional value. Call the TagCertificateAuthority\n\t\t\taction to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.

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

Lists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3652,19 +3652,19 @@ "MaxResults": { "target": "com.amazonaws.acmpca#MaxResults", "traits": { - "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to\n\t\t\treturn in the response. If additional items exist beyond the number you specify, the\n\t\t\t\tNextToken element is sent in the response. Use this\n\t\t\t\tNextToken value in a subsequent request to retrieve\n\t\t\tadditional items.

" + "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

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

Use this parameter when paginating results in a subsequent request after you receive a\n\t\t\tresponse with truncated results. Set it to the value of NextToken from the response you just received.

" + "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

" } }, "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n

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

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

", "smithy.api#required": {} } } @@ -3679,7 +3679,7 @@ "NextToken": { "target": "com.amazonaws.acmpca#NextToken", "traits": { - "smithy.api#documentation": "

When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.\n\t\t

" + "smithy.api#documentation": "

When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.

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

The current action was prevented because it would lock the caller out from performing\n\t\t\tsubsequent actions. Verify that the specified parameters would not result in the caller\n\t\t\tbeing denied access to the resource.

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

The current action was prevented because it would lock the caller out from performing subsequent actions. Verify that the specified parameters would not result in the caller being denied access to the resource.

", "smithy.api#error": "client" } }, @@ -3754,19 +3754,19 @@ "target": "com.amazonaws.acmpca#Boolean", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "

Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating\n\t\t\tcertificate revocation status.

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

Flag enabling use of the Online Certificate Status Protocol (OCSP) for validating certificate revocation status.

", "smithy.api#required": {} } }, "OcspCustomCname": { "target": "com.amazonaws.acmpca#CnameString", "traits": { - "smithy.api#documentation": "

By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by\n\t\t\tthe Online Certificate Status Protocol (OCSP). A customer can alternatively use this\n\t\t\tobject to define a CNAME specifying a customized OCSP domain.

\n \n

The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the\n\t\t\t\tuse of special characters in URIs. Additionally, the value of the CNAME must not\n\t\t\t\tinclude a protocol prefix such as \"http://\" or \"https://\".

\n \n

For more information, see Customizing Online Certificate Status Protocol\n\t\t\t\t(OCSP) in the Amazon Web Services Private Certificate Authority User Guide.

" + "smithy.api#documentation": "

By default, Amazon Web Services Private CA injects an Amazon Web Services domain into certificates being validated by the Online Certificate Status Protocol (OCSP). A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain.

The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\".

For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Amazon Web Services Private Certificate Authority User Guide.

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

Contains information to enable and configure Online Certificate Status Protocol (OCSP)\n\t\t\tfor validating certificate revocation status.

\n

When you revoke a certificate, OCSP responses may take up to 60 minutes \n\tto reflect the new status.

" + "smithy.api#documentation": "

Contains information to enable and configure Online Certificate Status Protocol (OCSP) for validating certificate revocation status.

When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.

" } }, "com.amazonaws.acmpca#OtherName": { @@ -3788,7 +3788,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines a custom ASN.1 X.400 GeneralName using an object identifier (OID)\n\t\t\tand value. The OID must satisfy the regular expression shown below. For more\n\t\t\tinformation, see NIST's definition of Object Identifier\n\t\t\t\t(OID).

" + "smithy.api#documentation": "

Defines a custom ASN.1 X.400 GeneralName using an object identifier (OID) and value. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID).

" } }, "com.amazonaws.acmpca#PermanentDeletionTimeInDays": { @@ -3806,7 +3806,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the private CA from which the permission was\n\t\t\tissued.

" + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the private CA from which the permission was issued.

" } }, "CreatedAt": { @@ -3818,7 +3818,7 @@ "Principal": { "target": "com.amazonaws.acmpca#Principal", "traits": { - "smithy.api#documentation": "

The Amazon Web Services service or entity that holds the permission. At this time, the only valid\n\t\t\tprincipal is acm.amazonaws.com.

" + "smithy.api#documentation": "

The Amazon Web Services service or entity that holds the permission. At this time, the only valid principal is acm.amazonaws.com.

" } }, "SourceAccount": { @@ -3841,7 +3841,7 @@ } }, "traits": { - "smithy.api#documentation": "

Permissions designate which private CA actions can be performed by an Amazon Web Services service or\n\t\t\tentity. In order for ACM to automatically renew private certificates, you must give\n\t\t\tthe ACM service principal all available permissions (IssueCertificate,\n\t\t\t\tGetCertificate, and ListPermissions). Permissions can be\n\t\t\tassigned with the CreatePermission action,\n\t\t\tremoved with the DeletePermission action, and\n\t\t\tlisted with the ListPermissions action.

" + "smithy.api#documentation": "

Permissions designate which private CA actions can be performed by an Amazon Web Services service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions (IssueCertificate, GetCertificate, and ListPermissions). Permissions can be assigned with the CreatePermission action, removed with the DeletePermission action, and listed with the ListPermissions action.

" } }, "com.amazonaws.acmpca#PermissionAlreadyExistsException": { @@ -3873,14 +3873,14 @@ "CertPolicyId": { "target": "com.amazonaws.acmpca#CustomObjectIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the object identifier (OID) of the certificate policy under which the\n\t\t\tcertificate was issued. For more information, see NIST's definition of Object Identifier\n\t\t\t\t(OID).

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

Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST's definition of Object Identifier (OID).

", "smithy.api#required": {} } }, "PolicyQualifiers": { "target": "com.amazonaws.acmpca#PolicyQualifierInfoList", "traits": { - "smithy.api#documentation": "

Modifies the given CertPolicyId with a qualifier. Amazon Web Services Private CA supports the\n\t\t\tcertification practice statement (CPS) qualifier.

" + "smithy.api#documentation": "

Modifies the given CertPolicyId with a qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier.

" } } }, @@ -3912,13 +3912,13 @@ "Qualifier": { "target": "com.amazonaws.acmpca#Qualifier", "traits": { - "smithy.api#documentation": "

Defines the qualifier type. Amazon Web Services Private CA supports the use of a URI for a CPS qualifier\n\t\t\tin this field.

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

Defines the qualifier type. Amazon Web Services Private CA supports the use of a URI for a CPS qualifier in this field.

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

Modifies the CertPolicyId of a PolicyInformation object with\n\t\t\ta qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS)\n\t\t\tqualifier.

" + "smithy.api#documentation": "

Modifies the CertPolicyId of a PolicyInformation object with a qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier.

" } }, "com.amazonaws.acmpca#PolicyQualifierInfoList": { @@ -3983,7 +3983,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches a resource-based policy to a private CA.

\n

A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access\n\t\t\tManager (RAM). For more information, see Attach a Policy for Cross-Account\n\t\t\tAccess.

\n

The policy can be displayed with GetPolicy and removed with DeletePolicy.

\n

\n About Policies\n

\n
    \n
  • \n

    A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to\n\t\t\tan Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, \n\t\t\tsee Using a Resource Based Policy with Amazon Web Services Private CA.

    \n
    • \n
  • \n

    A policy permits a user of Certificate Manager (ACM) to issue ACM certificates \n\t\t\tsigned by a CA in another account.

    \n
    • \n
  • \n

    For ACM to manage automatic renewal of these certificates, \n\t\t\tthe ACM user must configure a Service Linked Role (SLR). The SLR allows \n\t\t\tthe ACM service to assume the identity of the user, subject to confirmation against the \n\t\t\tAmazon Web Services Private CA policy. For more information, see \n\t\t\tUsing a\n Service Linked Role with ACM.

    \n
    • \n
  • \n

    Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information,\n\t\t\tsee Attach a Policy for Cross-Account \n\t\t\tAccess.

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

Attaches a resource-based policy to a private CA.

A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access.

The policy can be displayed with GetPolicy and removed with DeletePolicy.

About Policies

  • A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.

  • A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.

  • For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.

  • Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.

" } }, "com.amazonaws.acmpca#PutPolicyRequest": { @@ -3992,14 +3992,14 @@ "ResourceArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the private CA to associate with the policy. The\n\t\t\tARN of the CA can be found by calling the ListCertificateAuthorities action.

\n

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

The Amazon Resource Number (ARN) of the private CA to associate with the policy. The ARN of the CA can be found by calling the ListCertificateAuthorities action.

", "smithy.api#required": {} } }, "Policy": { "target": "com.amazonaws.acmpca#AWSPolicy", "traits": { - "smithy.api#documentation": "

The path and file name of a JSON-formatted IAM policy to attach to the specified\n\t\t\tprivate CA resource. If this policy does not contain all required statements or if it\n\t\t\tincludes any statement that is not allowed, the PutPolicy action returns an\n\t\t\t\tInvalidPolicyException. For information about IAM policy and\n\t\t\tstatement structure, see Overview of JSON Policies.

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

The path and file name of a JSON-formatted IAM policy to attach to the specified private CA resource. If this policy does not contain all required statements or if it includes any statement that is not allowed, the PutPolicy action returns an InvalidPolicyException. For information about IAM policy and statement structure, see Overview of JSON Policies.

", "smithy.api#required": {} } } @@ -4014,13 +4014,13 @@ "CpsUri": { "target": "com.amazonaws.acmpca#String256", "traits": { - "smithy.api#documentation": "

Contains a pointer to a certification practice statement (CPS) published by the\n\t\t\tCA.

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

Contains a pointer to a certification practice statement (CPS) published by the CA.

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

Defines a PolicyInformation qualifier. Amazon Web Services Private CA supports the certification\n\t\t\t\tpractice statement (CPS) qualifier defined in RFC 5280.

" + "smithy.api#documentation": "

Defines a PolicyInformation qualifier. Amazon Web Services Private CA supports the certification practice statement (CPS) qualifier defined in RFC 5280.

" } }, "com.amazonaws.acmpca#RequestAlreadyProcessedException": { @@ -4067,7 +4067,7 @@ } }, "traits": { - "smithy.api#documentation": "

A resource such as a private CA, S3 bucket, certificate, audit report, or policy\n\t\t\tcannot be found.

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

A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.

", "smithy.api#error": "client" } }, @@ -4108,7 +4108,7 @@ } ], "traits": { - "smithy.api#documentation": "

Restores a certificate authority (CA) that is in the DELETED state. You\n\t\t\tcan restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days.\n\t\t\tIf you did not specify a PermanentDeletionTimeInDays\n\t\t\tvalue, by default you can restore the CA at any time in a 30 day period. You can check\n\t\t\tthe time remaining in the restoration period of a private CA in the DELETED\n\t\t\tstate by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to\n\t\t\tits pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to\n\t\t\t\tACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the\n\t\t\t\tPENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate\n\t\t\tauthority into the private CA before it can be activated. You cannot restore a CA after\n\t\t\tthe restoration period has ended.

" + "smithy.api#documentation": "

Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.

" } }, "com.amazonaws.acmpca#RestoreCertificateAuthorityRequest": { @@ -4117,7 +4117,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n

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

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

", "smithy.api#required": {} } } @@ -4132,18 +4132,18 @@ "CrlConfiguration": { "target": "com.amazonaws.acmpca#CrlConfiguration", "traits": { - "smithy.api#documentation": "

Configuration of the certificate revocation list (CRL), if any, maintained by your\n\t\t\tprivate CA. A CRL is typically updated approximately 30 minutes after a certificate \n\tis revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts \n\tevery 15 minutes.

" + "smithy.api#documentation": "

Configuration of the certificate revocation list (CRL), if any, maintained by your private CA. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.

" } }, "OcspConfiguration": { "target": "com.amazonaws.acmpca#OcspConfiguration", "traits": { - "smithy.api#documentation": "

Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained\n\t\t\tby your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes \n\tto reflect the new status.

" + "smithy.api#documentation": "

Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.

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

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA)\n\t\t\tcan configure Online Certificate Status Protocol (OCSP) support and/or maintain a\n\t\t\tcertificate revocation list (CRL). OCSP returns validation information about\n\t\t\tcertificates as requested by clients, and a CRL contains an updated list of certificates\n\t\t\trevoked by your CA. For more information, see RevokeCertificate and Setting up a\n\t\t\t\tcertificate revocation method in the Amazon Web Services Private Certificate Authority User\n\t\t\t\tGuide.

" + "smithy.api#documentation": "

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see RevokeCertificate and Setting up a certificate revocation method in the Amazon Web Services Private Certificate Authority User Guide.

" } }, "com.amazonaws.acmpca#RevocationReason": { @@ -4237,7 +4237,7 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate\n\t\t\trevocation list (CRL) when you create or update your private CA, information about the\n\t\t\trevoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3\n\t\t\tbucket that you specify. A CRL is typically updated approximately 30 minutes after a\n\t\t\tcertificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts\n\t\t\tmakes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms\n\t\t\tfor the metrics CRLGenerated and MisconfiguredCRLBucket. For\n\t\t\tmore information, see Supported CloudWatch Metrics.

\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 also writes revocation information to the audit report. For more\n\t\t\tinformation, see CreateCertificateAuthorityAuditReport.

\n \n

You cannot revoke a root CA self-signed certificate.

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

Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.

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

Amazon Web Services Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

You cannot revoke a root CA self-signed certificate.

" } }, "com.amazonaws.acmpca#RevokeCertificateRequest": { @@ -4246,14 +4246,14 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the private CA that issued the certificate to be\n\t\t\trevoked. This must be of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n

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

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

", "smithy.api#required": {} } }, "CertificateSerial": { "target": "com.amazonaws.acmpca#String128", "traits": { - "smithy.api#documentation": "

Serial number of the certificate to be revoked. This must be in hexadecimal format.\n\t\t\tYou can retrieve the serial number by calling GetCertificate with the Amazon\n\t\t\tResource Name (ARN) of the certificate you want and the ARN of your private CA. The\n\t\t\t\tGetCertificate action retrieves the certificate in\n\t\t\tthe PEM format. You can use the following OpenSSL command to list the certificate in\n\t\t\ttext format and copy the hexadecimal serial number.

\n

\n openssl x509 -in file_path -text -noout\n

\n

You can also copy the serial number from the console or use the DescribeCertificate action in the Certificate Manager API\n\t\t\t\tReference.

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

Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.

openssl x509 -in file_path -text -noout

You can also copy the serial number from the console or use the DescribeCertificate action in the Certificate Manager API Reference.

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

Tags are labels that you can use to identify and organize your private CAs. Each tag\n\t\t\tconsists of a key and an optional value. You can associate up to 50 tags with a private\n\t\t\tCA. To add one or more tags to a private CA, call the TagCertificateAuthority\n\t\t\taction. To remove a tag, call the UntagCertificateAuthority action.

" + "smithy.api#documentation": "

Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action.

" } }, "com.amazonaws.acmpca#TagCertificateAuthority": { @@ -4504,7 +4504,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more tags to your private CA. Tags are labels that you can use to identify\n\t\t\tand organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You\n\t\t\tspecify the private CA on input by its Amazon Resource Name (ARN). You specify the tag\n\t\t\tby using a key-value pair. You can apply a tag to just one private CA if you want to\n\t\t\tidentify a specific characteristic of that CA, or you can apply the same tag to multiple\n\t\t\tprivate CAs if you want to filter for a common relationship among those CAs. To remove\n\t\t\tone or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are\n\t\t\tassociated with your CA.

\n \n

To attach tags to a private CA during the creation procedure, a CA administrator\n\t\t\t\tmust first associate an inline IAM policy with the\n\t\t\t\t\tCreateCertificateAuthority action and explicitly allow tagging. For\n\t\t\t\tmore information, see Attaching tags to a CA\n\t\t\t\t\tat the time of creation.

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

Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA.

To attach tags to a private CA during the creation procedure, a CA administrator must first associate an inline IAM policy with the CreateCertificateAuthority action and explicitly allow tagging. For more information, see Attaching tags to a CA at the time of creation.

" } }, "com.amazonaws.acmpca#TagCertificateAuthorityRequest": { @@ -4513,7 +4513,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

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

You can associate up to 50 tags with a private CA. Exception information is contained\n\t\t\tin the exception message field.

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

You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.

", "smithy.api#error": "client" } }, @@ -4596,7 +4596,7 @@ } ], "traits": { - "smithy.api#documentation": "

Remove one or more tags from your private CA. A tag consists of a key-value pair. If\n\t\t\tyou do not specify the value portion of the tag when calling this action, the tag will\n\t\t\tbe removed regardless of value. If you specify a value, the tag is removed only if it is\n\t\t\tassociated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are\n\t\t\tassociated with your CA.

" + "smithy.api#documentation": "

Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are associated with your CA.

" } }, "com.amazonaws.acmpca#UntagCertificateAuthorityRequest": { @@ -4605,7 +4605,7 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n

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

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

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

Updates the status or configuration of a private certificate authority (CA). Your\n\t\t\tprivate CA must be in the ACTIVE or DISABLED state before you\n\t\t\tcan update it. You can disable a private CA that is in the ACTIVE state or\n\t\t\tmake a CA that is in the DISABLED state active again.

\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 " + "smithy.api#documentation": "

Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again.

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

" } }, "com.amazonaws.acmpca#UpdateCertificateAuthorityRequest": { @@ -4659,14 +4659,14 @@ "CertificateAuthorityArn": { "target": "com.amazonaws.acmpca#Arn", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the private CA that issued the certificate to be\n\t\t\trevoked. This must be of the form:

\n

\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n \n

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

Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

", "smithy.api#required": {} } }, "RevocationConfiguration": { "target": "com.amazonaws.acmpca#RevocationConfiguration", "traits": { - "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 " + "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 information, see the OcspConfiguration and CrlConfiguration types.

The following requirements apply to revocation configurations.

  • A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.

  • In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.

  • A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.

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

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.

" } }, "Status": { @@ -4693,13 +4693,13 @@ "Type": { "target": "com.amazonaws.acmpca#ValidityPeriodType", "traits": { - "smithy.api#documentation": "

Determines how Amazon Web Services Private CA interprets the Value\n\t\t\tparameter, an integer. Supported validity types include those listed below. Type\n\t\t\tdefinitions with values include a sample input value and the resulting output.

\n

\n END_DATE: The specific date and time when the certificate will expire,\n\t\t\texpressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When\n\t\t\tUTCTime is used, if the year field (YY) is greater than or equal to 50, the year is\n\t\t\tinterpreted as 19YY. If the year field is less than 50, the year is interpreted as\n\t\t\t20YY.

\n
    \n
  • \n

    Sample input value: 491231235959 (UTCTime format)

    \n
    • \n
  • \n

    Output expiration date/time: 12/31/2049 23:59:59

    \n
    • \n
\n

\n ABSOLUTE: The specific date and time when the validity of a certificate\n\t\t\twill start or expire, expressed in seconds since the Unix Epoch.

\n
    \n
  • \n

    Sample input value: 2524608000

    \n
    • \n
  • \n

    Output expiration date/time: 01/01/2050 00:00:00

    \n
    • \n
\n

\n DAYS, MONTHS, YEARS: The relative time from the\n\t\t\tmoment of issuance until the certificate will expire, expressed in days, months, or\n\t\t\tyears.

\n

Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:

\n
    \n
  • \n

    Sample input value: 90

    \n
    • \n
  • \n

    Output expiration date: 01/10/2020 12:34:54 UTC

    \n
    • \n
\n

The minimum validity duration for a certificate using relative time\n\t\t\t(DAYS) is one day. The minimum validity for a certificate using absolute\n\t\t\ttime (ABSOLUTE or END_DATE) is one second.

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

Determines how Amazon Web Services Private CA interprets the Value parameter, an integer. Supported validity types include those listed below. Type definitions with values include a sample input value and the resulting output.

END_DATE: The specific date and time when the certificate will expire, expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50, the year is interpreted as 20YY.

  • Sample input value: 491231235959 (UTCTime format)

  • Output expiration date/time: 12/31/2049 23:59:59

ABSOLUTE: The specific date and time when the validity of a certificate will start or expire, expressed in seconds since the Unix Epoch.

  • Sample input value: 2524608000

  • Output expiration date/time: 01/01/2050 00:00:00

DAYS, MONTHS, YEARS: The relative time from the moment of issuance until the certificate will expire, expressed in days, months, or years.

Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:

  • Sample input value: 90

  • Output expiration date: 01/10/2020 12:34:54 UTC

The minimum validity duration for a certificate using relative time (DAYS) is one day. The minimum validity for a certificate using absolute time (ABSOLUTE or END_DATE) is one second.

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

Validity specifies the period of time during which a certificate is valid. Validity\n\t\t\tcan be expressed as an explicit date and time when the validity of a certificate starts\n\t\t\tor expires, or as a span of time after issuance, stated in days, months, or years. For\n\t\t\tmore information, see Validity in RFC 5280.

\n

Amazon Web Services Private CA API consumes the Validity data type differently in two\n\t\t\tdistinct parameters of the IssueCertificate action. The required parameter\n\t\t\t\tIssueCertificate:Validity specifies the end of a\n\t\t\tcertificate's validity period. The optional parameter\n\t\t\t\tIssueCertificate:ValidityNotBefore specifies a customized\n\t\t\tstarting time for the validity period.

" + "smithy.api#documentation": "

Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the validity of a certificate starts or expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.

Amazon Web Services Private CA API consumes the Validity data type differently in two distinct parameters of the IssueCertificate action. The required parameter IssueCertificate:Validity specifies the end of a certificate's validity period. The optional parameter IssueCertificate:ValidityNotBefore specifies a customized starting time for the validity period.

" } }, "com.amazonaws.acmpca#ValidityPeriodType": { diff --git a/codegen/sdk/aws-models/aiops.json b/codegen/sdk/aws-models/aiops.json index 3acf6e1b44c..58ee00123dc 100644 --- a/codegen/sdk/aws-models/aiops.json +++ b/codegen/sdk/aws-models/aiops.json @@ -815,7 +815,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an investigation group in your account. Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.

Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

  • Who can access the investigations

  • Whether investigation data is encrypted with a customer managed Key Management Service key.

  • How long investigations and their data are retained by default.

Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has the either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with CreateInvestigationGroup and you want to enable alarms to do this, you must use PutInvestigationGroupPolicy to create a resource policy that grants this permission to CloudWatch alarms.

For more information about configuring CloudWatch alarms to work with CloudWatch investigations, see

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

Creates an investigation group in your account. Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations.

Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following:

  • Who can access the investigations

  • Whether investigation data is encrypted with a customer managed Key Management Service key.

  • How long investigations and their data are retained by default.

Currently, you can have one investigation group in each Region in your account. Each investigation in a Region is a part of the investigation group in that Region

To create an investigation group and set up CloudWatch investigations, you must be signed in to an IAM principal that has either the AIOpsConsoleAdminPolicy or the AdministratorAccess IAM policy attached, or to an account that has similar permissions.

You can configure CloudWatch alarms to start investigations and add events to investigations. If you create your investigation group with CreateInvestigationGroup and you want to enable alarms to do this, you must use PutInvestigationGroupPolicy to create a resource policy that grants this permission to CloudWatch alarms.

For more information about configuring CloudWatch alarms, see Using Amazon CloudWatch alarms

", "smithy.api#http": { "code": 201, "method": "POST", @@ -853,7 +853,7 @@ "roleArn": { "target": "com.amazonaws.aiops#RoleArn", "traits": { - "smithy.api#documentation": "

Specify the ARN of the IAM role that CloudWatch investigations will use when it gathers investigation data. The permissions in this role determine which of your resources that CloudWatch investigations will have access to during investigations.

For more information, see How to control what data Amazon Q has access to during investigations.

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

Specify the ARN of the IAM role that CloudWatch investigations will use when it gathers investigation data. The permissions in this role determine which of your resources that CloudWatch investigations will have access to during investigations.

For more information, see How to control what data CloudWatch investigations has access to during investigations.

", "smithy.api#required": {} } }, @@ -878,13 +878,13 @@ "tagKeyBoundaries": { "target": "com.amazonaws.aiops#TagKeyBoundaries", "traits": { - "smithy.api#documentation": "

Enter the existing custom tag keys for custom applications in your system. Resource tags help Amazon Q narrow the search space when it is unable to discover definite relationships between resources. For example, to discover that an Amazon ECS service depends on an Amazon RDS database, Amazon Q can discover this relationship using data sources such as X-Ray and CloudWatch Application Signals. However, if you haven't deployed these features, Amazon Q will attempt to identify possible relationships. Tag boundaries can be used to narrow the resources that will be discovered by Amazon Q in these cases.

You don't need to enter tags created by myApplications or CloudFormation, because Amazon Q can automatically detect those tags.

" + "smithy.api#documentation": "

Enter the existing custom tag keys for custom applications in your system. Resource tags help CloudWatch investigations narrow the search space when it is unable to discover definite relationships between resources. For example, to discover that an Amazon ECS service depends on an Amazon RDS database, CloudWatch investigations can discover this relationship using data sources such as X-Ray and CloudWatch Application Signals. However, if you haven't deployed these features, CloudWatch investigations will attempt to identify possible relationships. Tag boundaries can be used to narrow the resources that will be discovered by CloudWatch investigations in these cases.

You don't need to enter tags created by myApplications or CloudFormation, because CloudWatch investigations can automatically detect those tags.

" } }, "chatbotNotificationChannel": { "target": "com.amazonaws.aiops#ChatbotNotificationChannel", "traits": { - "smithy.api#documentation": "

Use this structure to integrate CloudWatch investigations with Amazon Q in chat applications. This structure is a string array. For the first string, specify the ARN of an Amazon SNS topic. For the array of strings, specify the ARNs of one or more Amazon Q in chat applications configurations that you want to associate with that topic. For more information about these configuration ARNs, see Getting started with Amazon Q in chat applications and Resource type defined by Amazon Web Services Chatbot.

" + "smithy.api#documentation": "

Use this structure to integrate CloudWatch investigations with chat applications. This structure is a string array. For the first string, specify the ARN of an Amazon SNS topic. For the array of strings, specify the ARNs of one or more chat applications configurations that you want to associate with that topic. For more information about these configuration ARNs, see Getting started with Amazon Q in chat applications and Resource type defined by Amazon Web Services Chatbot.

" } }, "isCloudTrailEventHistoryEnabled": { @@ -896,7 +896,7 @@ "crossAccountConfigurations": { "target": "com.amazonaws.aiops#CrossAccountConfigurations", "traits": { - "smithy.api#documentation": "

Number of sourceAccountId values that have been configured for cross-account access.

" + "smithy.api#documentation": "

List of sourceRoleArn values that have been configured for cross-account access.

" } } }, @@ -1084,7 +1084,7 @@ "type": { "target": "com.amazonaws.aiops#EncryptionConfigurationType", "traits": { - "smithy.api#documentation": "

Displays whether investigation data is encrypted by a customer managed key or an Amazon Web Services owned kay.

" + "smithy.api#documentation": "

Displays whether investigation data is encrypted by a customer managed key or an Amazon Web Services owned key.

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

Returns the IAM resource policy that is associated with the specified investigation group.

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

Returns the JSON of the IAM resource policy associated with the specified investigation group in a string. For example, {\\\"Version\\\":\\\"2012-10-17\\\",\\\"Statement\\\":[{\\\"Effect\\\":\\\"Allow\\\",\\\"Principal\\\":{\\\"Service\\\":\\\"aiops.alarms.cloudwatch.amazonaws.com\\\"},\\\"Action\\\":[\\\"aiops:CreateInvestigation\\\",\\\"aiops:CreateInvestigationEvent\\\"],\\\"Resource\\\":\\\"*\\\",\\\"Condition\\\":{\\\"StringEquals\\\":{\\\"aws:SourceAccount\\\":\\\"111122223333\\\"},\\\"ArnLike\\\":{\\\"aws:SourceArn\\\":\\\"arn:aws:cloudwatch:us-east-1:111122223333:alarm:*\\\"}}}]}.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -1251,7 +1251,7 @@ "identifier": { "target": "com.amazonaws.aiops#InvestigationGroupIdentifier", "traits": { - "smithy.api#documentation": "

Specify either the name or the ARN of the investigation group that you want to view.

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

Specify either the name or the ARN of the investigation group that you want to view. This is used to set the name of the investigation group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1285,7 +1285,7 @@ } }, "createdAt": { - "target": "smithy.api#Timestamp", + "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The date and time that the investigation group was created.

" } @@ -1297,7 +1297,7 @@ } }, "lastModifiedAt": { - "target": "smithy.api#Timestamp", + "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The date and time that the investigation group was most recently modified.

" } @@ -1335,13 +1335,13 @@ "chatbotNotificationChannel": { "target": "com.amazonaws.aiops#ChatbotNotificationChannel", "traits": { - "smithy.api#documentation": "

This structure is a string array. The first string is the ARN of a Amazon SNS topic. The array of strings display the ARNs of Amazon Q in chat applications configurations that are associated with that topic. For more information about these configuration ARNs, see Getting started with Amazon Q in chat applications and Resource type defined by Amazon Web Services Chatbot.

" + "smithy.api#documentation": "

This structure is a string array. The first string is the ARN of a Amazon SNS topic. The array of strings display the ARNs of chat applications configurations that are associated with that topic. For more information about these configuration ARNs, see Getting started with Amazon Q in chat applications and Resource type defined by Amazon Web Services Chatbot.

" } }, "tagKeyBoundaries": { "target": "com.amazonaws.aiops#TagKeyBoundaries", "traits": { - "smithy.api#documentation": "

Displays the custom tag keys for custom applications in your system that you have specified in the investigation group. Resource tags help Amazon Q narrow the search space when it is unable to discover definite relationships between resources.

" + "smithy.api#documentation": "

Displays the custom tag keys for custom applications in your system that you have specified in the investigation group. Resource tags help CloudWatch investigations narrow the search space when it is unable to discover definite relationships between resources.

" } }, "isCloudTrailEventHistoryEnabled": { @@ -1408,7 +1408,7 @@ "target": "com.amazonaws.aiops#Retention" }, "lastModifiedAt": { - "target": "smithy.api#Timestamp" + "target": "smithy.api#Long" }, "lastModifiedBy": { "target": "com.amazonaws.aiops#IdentifierStringWithPatternAndLengthLimits" @@ -1417,7 +1417,7 @@ "target": "com.amazonaws.aiops#IdentifierStringWithPatternAndLengthLimits" }, "createdAt": { - "target": "smithy.api#Timestamp" + "target": "smithy.api#Long" }, "tags": { "target": "com.amazonaws.aiops#Tags" @@ -1672,7 +1672,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of the CloudWatch investigations resource that you want to view tags for. You can use the ListInvestigationGroups operation to find the ARNs of investigation groups.

The ARN format for an investigation group is arn:aws:aiops:Region:account-id:investigation-group:investigation-group-id .

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

The ARN of the CloudWatch investigations resource that you want to view tags for. You can use the ListInvestigationGroups operation to find the ARNs of investigation groups.

The ARN format for an investigation group is arn:aws:aiops:Region:account-id:investigation-group:investigation-group-id .

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

Creates an IAM resource policy and assigns it to the specified investigation group.

If you create your investigation group with CreateInvestigationGroup and you want to enable CloudWatch alarms to create investigations and add events to investigations, you must use this operation to create a policy similar to this example.

{ \"Version\": \"2008-10-17\", \"Statement\": [{ \"Effect\": \"Allow\", \"Principal\": { \"Service\": \"aiops.alarms.cloudwatch.amazonaws.com\" }, \"Action\": [\"aiops:CreateInvestigation\", \"aiops:CreateInvestigationEvent\"], \"Resource\": \"*\", \"Condition\": { \"StringEquals\": { \"aws:SourceAccount\": \"account-id\" }, \"ArnLike\": { \"aws:SourceArn\": \"arn:aws:cloudwatch:region:account-id:alarm:*\" } } }] }

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

Creates an IAM resource policy and assigns it to the specified investigation group.

If you create your investigation group with CreateInvestigationGroup and you want to enable CloudWatch alarms to create investigations and add events to investigations, you must use this operation to create a policy similar to this example.

{ \"Version\": \"2008-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Principal\": { \"Service\": \"aiops.alarms.cloudwatch.amazonaws.com\" }, \"Action\": [ \"aiops:CreateInvestigation\", \"aiops:CreateInvestigationEvent\" ], \"Resource\": \"*\", \"Condition\": { \"StringEquals\": { \"aws:SourceAccount\": \"account-id\" }, \"ArnLike\": { \"aws:SourceArn\": \"arn:aws:cloudwatch:region:account-id:alarm:*\" } } } ] }

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1948,7 +1948,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to apply the tags to. You can use the ListInvestigationGroups operation to find the ARNs of investigation groups.

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

The Amazon Resource Name (ARN) of the resource that you want to apply the tags to. You can use the ListInvestigationGroups operation to find the ARNs of investigation groups.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2055,7 +2055,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to remove the tags from. You can use the ListInvestigationGroups operation to find the ARNs of investigation groups.

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

The Amazon Resource Name (ARN) of the resource that you want to remove the tags from. You can use theListInvestigationGroups operation to find the ARNs of investigation groups.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2147,7 +2147,7 @@ "roleArn": { "target": "com.amazonaws.aiops#RoleArn", "traits": { - "smithy.api#documentation": "

Specify this field if you want to change the IAM role that CloudWatch investigations will use when it gathers investigation data. To do so, specify the ARN of the new role.

The permissions in this role determine which of your resources that CloudWatch investigations will have access to during investigations.

For more information, see EHow to control what data Amazon Q has access to during investigations.

" + "smithy.api#documentation": "

Specify this field if you want to change the IAM role that CloudWatch investigations will use when it gathers investigation data. To do so, specify the ARN of the new role.

The permissions in this role determine which of your resources that CloudWatch investigations will have access to during investigations.

For more information, see How to control what data CloudWatch investigations has access to during investigations.

" } }, "encryptionConfiguration": { @@ -2159,13 +2159,13 @@ "tagKeyBoundaries": { "target": "com.amazonaws.aiops#TagKeyBoundaries", "traits": { - "smithy.api#documentation": "

Enter the existing custom tag keys for custom applications in your system. Resource tags help Amazon Q narrow the search space when it is unable to discover definite relationships between resources. For example, to discover that an Amazon ECS service depends on an Amazon RDS database, Amazon Q can discover this relationship using data sources such as X-Ray and CloudWatch Application Signals. However, if you haven't deployed these features, Amazon Q will attempt to identify possible relationships. Tag boundaries can be used to narrow the resources that will be discovered by Amazon Q in these cases.

You don't need to enter tags created by myApplications or CloudFormation, because Amazon Q can automatically detect those tags.

" + "smithy.api#documentation": "

Enter the existing custom tag keys for custom applications in your system. Resource tags help CloudWatch investigations narrow the search space when it is unable to discover definite relationships between resources. For example, to discover that an Amazon ECS service depends on an Amazon RDS database, CloudWatch investigations can discover this relationship using data sources such as X-Ray and CloudWatch Application Signals. However, if you haven't deployed these features, CloudWatch investigations will attempt to identify possible relationships. Tag boundaries can be used to narrow the resources that will be discovered by CloudWatch investigations in these cases.

You don't need to enter tags created by myApplications or CloudFormation, because CloudWatch investigations can automatically detect those tags.

" } }, "chatbotNotificationChannel": { "target": "com.amazonaws.aiops#ChatbotNotificationChannel", "traits": { - "smithy.api#documentation": "

Use this structure to integrate CloudWatch investigations with Amazon Q in chat applications. This structure is a string array. For the first string, specify the ARN of an Amazon SNS topic. For the array of strings, specify the ARNs of one or more Amazon Q in chat applications configurations that you want to associate with that topic. For more information about these configuration ARNs, see Getting started with Amazon Q in chat applications and Resource type defined by Amazon Web Services Chatbot.

" + "smithy.api#documentation": "

Use this structure to integrate CloudWatch investigations with chat applications. This structure is a string array. For the first string, specify the ARN of an Amazon SNS topic. For the array of strings, specify the ARNs of one or more chat applications configurations that you want to associate with that topic. For more information about these configuration ARNs, see Getting started with Amazon Q in chat applications and Resource type defined by Amazon Web Services Chatbot.

" } }, "isCloudTrailEventHistoryEnabled": { diff --git a/codegen/sdk/aws-models/appintegrations.json b/codegen/sdk/aws-models/appintegrations.json index 1b334a7a7f5..023b92dcacc 100644 --- a/codegen/sdk/aws-models/appintegrations.json +++ b/codegen/sdk/aws-models/appintegrations.json @@ -927,6 +927,20 @@ } } }, + "com.amazonaws.appintegrations#ApplicationConfig": { + "type": "structure", + "members": { + "ContactHandling": { + "target": "com.amazonaws.appintegrations#ContactHandling", + "traits": { + "smithy.api#documentation": "

The contact handling configuration for the application.

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

The configuration settings for the application.

" + } + }, "com.amazonaws.appintegrations#ApplicationName": { "type": "string", "traits": { @@ -999,6 +1013,13 @@ "traits": { "smithy.api#documentation": "

The time when the application was last modified.

" } + }, + "IsService": { + "target": "com.amazonaws.appintegrations#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the application is a service.

" + } } }, "traits": { @@ -1047,6 +1068,12 @@ "smithy.api#pattern": "^(arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}|[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})(:[\\w\\$]+)?$" } }, + "com.amazonaws.appintegrations#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.appintegrations#ClientAssociationMetadata": { "type": "map", "key": { @@ -1066,6 +1093,37 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.appintegrations#ContactHandling": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.appintegrations#ContactHandlingScope", + "traits": { + "smithy.api#documentation": "

Indicates whether the application refreshes for each contact or refreshes only with each new browser session.

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

The contact handling configuration for the application.

" + } + }, + "com.amazonaws.appintegrations#ContactHandlingScope": { + "type": "enum", + "members": { + "CROSS_CONTACTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CROSS_CONTACTS" + } + }, + "PER_CONTACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PER_CONTACT" + } + } + } + }, "com.amazonaws.appintegrations#CreateApplication": { "type": "operation", "input": { @@ -1192,6 +1250,31 @@ "traits": { "smithy.api#documentation": "

The configuration of events or requests that the application has access to.

" } + }, + "IsService": { + "target": "com.amazonaws.appintegrations#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the application is a service.

" + } + }, + "InitializationTimeout": { + "target": "com.amazonaws.appintegrations#InitializationTimeout", + "traits": { + "smithy.api#documentation": "

The maximum time in milliseconds allowed to establish a connection with the workspace.

" + } + }, + "ApplicationConfig": { + "target": "com.amazonaws.appintegrations#ApplicationConfig", + "traits": { + "smithy.api#documentation": "

The configuration settings for the application.

" + } + }, + "IframeConfig": { + "target": "com.amazonaws.appintegrations#IframeConfig", + "traits": { + "smithy.api#documentation": "

The iframe configuration for the application.

" + } } }, "traits": { @@ -2367,6 +2450,31 @@ "traits": { "smithy.api#documentation": "

The configuration of events or requests that the application has access to.

" } + }, + "IsService": { + "target": "com.amazonaws.appintegrations#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the application is a service.

" + } + }, + "InitializationTimeout": { + "target": "com.amazonaws.appintegrations#InitializationTimeout", + "traits": { + "smithy.api#documentation": "

The maximum time in milliseconds allowed to establish a connection with the workspace.

" + } + }, + "ApplicationConfig": { + "target": "com.amazonaws.appintegrations#ApplicationConfig", + "traits": { + "smithy.api#documentation": "

The configuration settings for the application.

" + } + }, + "IframeConfig": { + "target": "com.amazonaws.appintegrations#IframeConfig", + "traits": { + "smithy.api#documentation": "

The iframe configuration for the application.

" + } } }, "traits": { @@ -2605,6 +2713,59 @@ "smithy.api#pattern": "\\S" } }, + "com.amazonaws.appintegrations#IframeConfig": { + "type": "structure", + "members": { + "Allow": { + "target": "com.amazonaws.appintegrations#IframePermissionList", + "traits": { + "smithy.api#documentation": "

The list of features that are allowed in the iframe.

" + } + }, + "Sandbox": { + "target": "com.amazonaws.appintegrations#IframePermissionList", + "traits": { + "smithy.api#documentation": "

The list of sandbox attributes for the iframe.

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

The iframe configuration for the application.

" + } + }, + "com.amazonaws.appintegrations#IframePermission": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A permission for the iframe.

", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-z-]+$" + } + }, + "com.amazonaws.appintegrations#IframePermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.appintegrations#IframePermission" + }, + "traits": { + "smithy.api#documentation": "

A list of permissions for the iframe.

", + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.appintegrations#InitializationTimeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 600000 + } + } + }, "com.amazonaws.appintegrations#InternalServiceError": { "type": "structure", "members": { @@ -3836,6 +3997,31 @@ "traits": { "smithy.api#documentation": "

The configuration of events or requests that the application has access to.

" } + }, + "IsService": { + "target": "com.amazonaws.appintegrations#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Indicates whether the application is a service.

" + } + }, + "InitializationTimeout": { + "target": "com.amazonaws.appintegrations#InitializationTimeout", + "traits": { + "smithy.api#documentation": "

The maximum time in milliseconds allowed to establish a connection with the workspace.

" + } + }, + "ApplicationConfig": { + "target": "com.amazonaws.appintegrations#ApplicationConfig", + "traits": { + "smithy.api#documentation": "

The configuration settings for the application.

" + } + }, + "IframeConfig": { + "target": "com.amazonaws.appintegrations#IframeConfig", + "traits": { + "smithy.api#documentation": "

The iframe configuration for the application.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/arc-region-switch.json b/codegen/sdk/aws-models/arc-region-switch.json new file mode 100644 index 00000000000..111f67aa23b --- /dev/null +++ b/codegen/sdk/aws-models/arc-region-switch.json @@ -0,0 +1,5386 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.arcregionswitch#AbbreviatedExecution": { + "type": "structure", + "members": { + "planArn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan.

", + "smithy.api#required": {} + } + }, + "executionId": { + "target": "com.amazonaws.arcregionswitch#ExecutionId", + "traits": { + "smithy.api#documentation": "

The execution identifier of a plan execution.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "smithy.api#String", + "traits": { + "aws.cloudformation#cfnMutability": "read", + "smithy.api#documentation": "

The version for the plan.

" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The timestamp when the plan execution was last updated.

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

An optional comment about the plan execution.

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

The timestamp when the plan execution was started.

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

The timestamp when the plan execution was ended.

" + } + }, + "mode": { + "target": "com.amazonaws.arcregionswitch#ExecutionMode", + "traits": { + "smithy.api#documentation": "

The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

", + "smithy.api#required": {} + } + }, + "executionState": { + "target": "com.amazonaws.arcregionswitch#ExecutionState", + "traits": { + "smithy.api#documentation": "

The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.

", + "smithy.api#required": {} + } + }, + "executionAction": { + "target": "com.amazonaws.arcregionswitch#ExecutionAction", + "traits": { + "smithy.api#documentation": "

The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.

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

The Amazon Web Services Region for a plan execution.

", + "smithy.api#required": {} + } + }, + "actualRecoveryTime": { + "target": "com.amazonaws.arcregionswitch#Duration", + "traits": { + "smithy.api#documentation": "

The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.

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

A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.

" + } + }, + "com.amazonaws.arcregionswitch#AbbreviatedExecutionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#AbbreviatedExecution" + } + }, + "com.amazonaws.arcregionswitch#AbbreviatedPlan": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Region switch plan.

", + "smithy.api#required": {} + } + }, + "owner": { + "target": "com.amazonaws.arcregionswitch#AccountId", + "traits": { + "aws.cloudformation#cfnMutability": "read", + "smithy.api#documentation": "

The owner of a Region switch plan.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.arcregionswitch#PlanName", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The name of a Region switch plan.

", + "smithy.api#required": {} + } + }, + "regions": { + "target": "com.amazonaws.arcregionswitch#RegionList", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The Amazon Web Services Region specified for a Region switch plan.

", + "smithy.api#required": {} + } + }, + "recoveryApproach": { + "target": "com.amazonaws.arcregionswitch#RecoveryApproach", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

", + "smithy.api#required": {} + } + }, + "primaryRegion": { + "target": "com.amazonaws.arcregionswitch#Region", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The primary Region for a plan.

" + } + }, + "version": { + "target": "smithy.api#String", + "traits": { + "aws.cloudformation#cfnMutability": "read", + "smithy.api#documentation": "

The version for the plan.

" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The timestamp when the plan execution was last updated.

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

The description of a Region switch plan.

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

The execution role is a way to categorize a Region switch plan.

" + } + }, + "activePlanExecution": { + "target": "com.amazonaws.arcregionswitch#ExecutionId", + "traits": { + "smithy.api#documentation": "

Specifies if this is the active plan execution at this time.

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

The recovery time objective that you've specified.

", + "smithy.api#range": { + "min": 1, + "max": 10080 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

A summarized representation of a Region switch plan. This structure contains key information about a plan without all the detailed workflow and step data.

" + } + }, + "com.amazonaws.arcregionswitch#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

HTTP Status Code: 403

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.arcregionswitch#AccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.arcregionswitch#AlarmCondition": { + "type": "enum", + "members": { + "RED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "red" + } + }, + "GREEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "green" + } + } + } + }, + "com.amazonaws.arcregionswitch#AlarmType": { + "type": "enum", + "members": { + "APPLICATION_HEALTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "applicationHealth" + } + }, + "TRIGGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trigger" + } + } + } + }, + "com.amazonaws.arcregionswitch#Approval": { + "type": "enum", + "members": { + "APPROVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "approve" + } + }, + "DECLINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "decline" + } + } + } + }, + "com.amazonaws.arcregionswitch#ApprovePlanExecutionStep": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#ApprovePlanExecutionStepRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#ApprovePlanExecutionStepResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#AccessDeniedException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to approve a plan execution step" + }, + "smithy.api#documentation": "

Approves a step in a plan execution that requires manual approval. When you create a plan, you can include approval steps that require manual intervention before the execution can proceed. This operation allows you to provide that approval.

You must specify the plan ARN, execution ID, step name, and approval status. You can also provide an optional comment explaining the approval decision.

" + } + }, + "com.amazonaws.arcregionswitch#ApprovePlanExecutionStepRequest": { + "type": "structure", + "members": { + "planArn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan.

", + "smithy.api#required": {} + } + }, + "executionId": { + "target": "com.amazonaws.arcregionswitch#ExecutionId", + "traits": { + "smithy.api#documentation": "

The execution identifier of a plan execution.

", + "smithy.api#required": {} + } + }, + "stepName": { + "target": "com.amazonaws.arcregionswitch#StepName", + "traits": { + "smithy.api#documentation": "

The name of a step in a plan execution.

", + "smithy.api#required": {} + } + }, + "approval": { + "target": "com.amazonaws.arcregionswitch#Approval", + "traits": { + "smithy.api#documentation": "

The status of approval for a plan execution step.

", + "smithy.api#required": {} + } + }, + "comment": { + "target": "com.amazonaws.arcregionswitch#ExecutionComment", + "traits": { + "smithy.api#documentation": "

A comment that you can enter about a plan execution.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#ApprovePlanExecutionStepResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#ArcRegionSwitch": { + "type": "service", + "version": "2022-07-26", + "operations": [ + { + "target": "com.amazonaws.arcregionswitch#ApprovePlanExecutionStep" + }, + { + "target": "com.amazonaws.arcregionswitch#CancelPlanExecution" + }, + { + "target": "com.amazonaws.arcregionswitch#GetPlanEvaluationStatus" + }, + { + "target": "com.amazonaws.arcregionswitch#GetPlanExecution" + }, + { + "target": "com.amazonaws.arcregionswitch#GetPlanInRegion" + }, + { + "target": "com.amazonaws.arcregionswitch#ListPlanExecutionEvents" + }, + { + "target": "com.amazonaws.arcregionswitch#ListPlanExecutions" + }, + { + "target": "com.amazonaws.arcregionswitch#ListPlansInRegion" + }, + { + "target": "com.amazonaws.arcregionswitch#ListRoute53HealthChecks" + }, + { + "target": "com.amazonaws.arcregionswitch#StartPlanExecution" + }, + { + "target": "com.amazonaws.arcregionswitch#UpdatePlanExecution" + }, + { + "target": "com.amazonaws.arcregionswitch#UpdatePlanExecutionStep" + } + ], + "resources": [ + { + "target": "com.amazonaws.arcregionswitch#RegionSwitchPlan" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "ARC Region switch", + "endpointPrefix": "arc-region-switch", + "arnNamespace": "arc-region-switch", + "cloudFormationName": "ARCRegionSwitch" + }, + "aws.auth#sigv4": { + "name": "arc-region-switch" + }, + "aws.endpoints#dualStackOnlyEndpoints": {}, + "aws.endpoints#rulesBasedEndpoints": {}, + "aws.endpoints#standardRegionalEndpoints": {}, + "aws.iam#defineConditionKeys": { + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by a tag's key and value in a request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by tag key-value pairs attached to the resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by the presence of tag keys in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" + } + }, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "

Amazon Application Recovery Controller (ARC) Region switch helps you to quickly and reliably shift traffic away from an impaired Amazon Web Services Region to a healthy Region. With Region switch, you can create plans that define the steps to shift traffic for your application from one Amazon Web Services Region to another. You can test your plans in practice mode before using them in a real recovery scenario.

Region switch provides a structured approach to multi-Region failover, helping you to meet your recovery time objectives (RTOs) and maintain business continuity during regional disruptions.

", + "smithy.api#title": "ARC - Region switch", + "smithy.protocols#rpcv2Cbor": {}, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "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" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseControlPlaneEndpoint": { + "required": false, + "documentation": "Whether the operation is a control plane operation. Control plane operations are routed to a centralized endpoint in the partition leader.", + "type": "Boolean" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "UseControlPlaneEndpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseControlPlaneEndpoint" + }, + true + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + }, + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-cn" + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://arc-region-switch-control-plane.cn-north-1.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "arc-region-switch", + "signingRegion": "cn-north-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "UseControlPlaneEndpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseControlPlaneEndpoint" + }, + true + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-cn" + ] + } + ], + "error": "Invalid Configuration: FIPS is not supported in this partition", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://arc-region-switch-control-plane-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "arc-region-switch", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "UseControlPlaneEndpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseControlPlaneEndpoint" + }, + true + ] + }, + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ] + }, + { + "fn": "not", + "argv": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ] + }, + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://arc-region-switch-control-plane.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "arc-region-switch", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "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": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "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 + ] + } + ], + "endpoint": { + "url": "https://arc-region-switch-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://arc-region-switch.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For custom endpoint with region not set and fips disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips enabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch-fips.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch-fips.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://arc-region-switch.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + }, + { + "documentation": "Control plane operation with DualStack in us-west-2 routes to us-east-1 DualStack endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1", + "signingName": "arc-region-switch" + } + ] + }, + "url": "https://arc-region-switch-control-plane.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-west-2", + "UseControlPlaneEndpoint": true + } + }, + { + "documentation": "Control plane operation with endpoint set in us-east-1 routes to provided endpoint", + "expect": { + "endpoint": { + "url": "https://amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseControlPlaneEndpoint": true, + "Endpoint": "https://amazonaws.com" + } + }, + { + "documentation": "Control plane operation with endpoint set in us-west-2 routes to provided endpoint", + "expect": { + "endpoint": { + "url": "https://amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseControlPlaneEndpoint": true, + "Endpoint": "https://amazonaws.com" + } + }, + { + "documentation": "Control plane operation in us-west-2 (standard partition) routes to us-east-1", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1", + "signingName": "arc-region-switch" + } + ] + }, + "url": "https://arc-region-switch-control-plane.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-west-2", + "UseControlPlaneEndpoint": true + } + }, + { + "documentation": "Control plane operation in cn-north-1 (China partition) routes to cn-north-1 with China DNS suffix", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-north-1", + "signingName": "arc-region-switch" + } + ] + }, + "url": "https://arc-region-switch-control-plane.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseControlPlaneEndpoint": true + } + }, + { + "documentation": "Control plane operation in cn-northwest-1 (China partition) routes to cn-north-1 with China DNS suffix", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-north-1", + "signingName": "arc-region-switch" + } + ] + }, + "url": "https://arc-region-switch-control-plane.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseControlPlaneEndpoint": true + } + }, + { + "documentation": "Control plane operation in us-gov-west-1 (GovCloud partition) routes to us-gov-west-1 with GovCloud DNS suffix", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1", + "signingName": "arc-region-switch" + } + ] + }, + "url": "https://arc-region-switch-control-plane.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseControlPlaneEndpoint": true + } + }, + { + "documentation": "Control plane operation in us-gov-east-1 (GovCloud partition) routes to us-gov-west-1 with GovCloud DNS suffix", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1", + "signingName": "arc-region-switch" + } + ] + }, + "url": "https://arc-region-switch-control-plane.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseControlPlaneEndpoint": true + } + }, + { + "documentation": "Control plane operation with FIPS in us-west-2 routes to us-east-1 FIPS endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1", + "signingName": "arc-region-switch" + } + ] + }, + "url": "https://arc-region-switch-control-plane-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-west-2", + "UseControlPlaneEndpoint": true, + "UseFIPS": true + } + }, + { + "documentation": "Control plane operation with FIPS in us-east-1 routes to us-east-1 FIPS endpoint", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1", + "signingName": "arc-region-switch" + } + ] + }, + "url": "https://arc-region-switch-control-plane-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseControlPlaneEndpoint": true, + "UseFIPS": true + } + }, + { + "documentation": "Control plane operation with FIPS in CN returns an error", + "expect": { + "error": "Invalid Configuration: FIPS is not supported in this partition" + }, + "params": { + "Region": "cn-north-1", + "UseControlPlaneEndpoint": true, + "UseFIPS": true + } + }, + { + "documentation": "Control plane operation with endpoint set using FIPS in us-east-1 errors", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseControlPlaneEndpoint": true, + "UseFIPS": true, + "Endpoint": "https://amazonaws.com" + } + }, + { + "documentation": "Control plane operation with endpoint set using FIPS in us-west-2 routes to provided endpoint", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-west-2", + "UseControlPlaneEndpoint": true, + "UseFIPS": true, + "Endpoint": "https://amazonaws.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.arcregionswitch#ArcRoutingControlConfiguration": { + "type": "structure", + "members": { + "timeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 60, + "smithy.api#documentation": "

The timeout value specified for the configuration.

", + "smithy.api#range": { + "min": 1 + } + } + }, + "crossAccountRole": { + "target": "com.amazonaws.arcregionswitch#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The cross account role for the configuration.

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

The external ID (secret key) for the configuration.

" + } + }, + "regionAndRoutingControls": { + "target": "com.amazonaws.arcregionswitch#RegionAndRoutingControls", + "traits": { + "smithy.api#documentation": "

The Region and ARC routing controls for the configuration.

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

Configuration for ARC routing controls used in a Region switch plan. Routing controls are simple on/off switches that you can use to shift traffic away from an impaired Region.

" + } + }, + "com.amazonaws.arcregionswitch#ArcRoutingControlState": { + "type": "structure", + "members": { + "routingControlArn": { + "target": "com.amazonaws.arcregionswitch#RoutingControlArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a routing control.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.arcregionswitch#RoutingControlStateChange", + "traits": { + "smithy.api#documentation": "

The state of an ARC routing control, On or Off.

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

Represents the state of an ARC routing control.

" + } + }, + "com.amazonaws.arcregionswitch#ArcRoutingControlStates": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#ArcRoutingControlState" + } + }, + "com.amazonaws.arcregionswitch#Asg": { + "type": "structure", + "members": { + "crossAccountRole": { + "target": "com.amazonaws.arcregionswitch#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The cross account role for the configuration.

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

The external ID (secret key) for the configuration.

" + } + }, + "arn": { + "target": "com.amazonaws.arcregionswitch#AsgArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.

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

Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.

" + } + }, + "com.amazonaws.arcregionswitch#AsgArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:autoscaling:[a-z0-9-]+:\\d{12}:autoScalingGroup:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:autoScalingGroupName/[\\S\\s]{1,255}$" + } + }, + "com.amazonaws.arcregionswitch#AsgList": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#Asg" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.arcregionswitch#AssociatedAlarm": { + "type": "structure", + "members": { + "crossAccountRole": { + "target": "com.amazonaws.arcregionswitch#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The cross account role for the configuration.

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

The external ID (secret key) for the configuration.

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

The resource identifier for alarms that you associate with a plan.

", + "smithy.api#required": {} + } + }, + "alarmType": { + "target": "com.amazonaws.arcregionswitch#AlarmType", + "traits": { + "smithy.api#documentation": "

The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.

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

An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.

" + } + }, + "com.amazonaws.arcregionswitch#AssociatedAlarmMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.arcregionswitch#AssociatedAlarm" + } + }, + "com.amazonaws.arcregionswitch#AuroraClusterArn": { + "type": "string" + }, + "com.amazonaws.arcregionswitch#AuroraClusterArns": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#AuroraClusterArn" + } + }, + "com.amazonaws.arcregionswitch#CancelPlanExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#CancelPlanExecutionRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#CancelPlanExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#AccessDeniedException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to cancel a plan execution" + }, + "smithy.api#documentation": "

Cancels an in-progress plan execution. This operation stops the execution of the plan and prevents any further steps from being processed.

You must specify the plan ARN and execution ID. You can also provide an optional comment explaining why the execution was canceled.

" + } + }, + "com.amazonaws.arcregionswitch#CancelPlanExecutionRequest": { + "type": "structure", + "members": { + "planArn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan.

", + "smithy.api#required": {} + } + }, + "executionId": { + "target": "com.amazonaws.arcregionswitch#ExecutionId", + "traits": { + "smithy.api#documentation": "

The execution identifier of a plan execution.

", + "smithy.api#required": {} + } + }, + "comment": { + "target": "com.amazonaws.arcregionswitch#ExecutionComment", + "traits": { + "smithy.api#documentation": "

A comment that you can enter about canceling a plan execution step.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#CancelPlanExecutionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#CreatePlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#CreatePlanRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#CreatePlanResponse" + }, + "traits": { + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to create a plan" + }, + "smithy.api#documentation": "

Creates a new Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.

You must specify a name for the plan, the primary Region, and at least one additional Region. You can also provide a description, execution role, recovery time objective, associated alarms, triggers, and workflows that define the steps to execute during a Region switch.

", + "smithy.rules#staticContextParams": { + "UseControlPlaneEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.arcregionswitch#CreatePlanRequest": { + "type": "structure", + "members": { + "description": { + "target": "smithy.api#String", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The description of a Region switch plan.

" + } + }, + "workflows": { + "target": "com.amazonaws.arcregionswitch#WorkflowList", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

An array of workflows included in a Region switch plan.

", + "smithy.api#required": {} + } + }, + "executionRole": { + "target": "com.amazonaws.arcregionswitch#IamRoleArn", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

An execution role is a way to categorize a Region switch plan.

", + "smithy.api#required": {} + } + }, + "recoveryTimeObjectiveMinutes": { + "target": "smithy.api#Integer", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.

", + "smithy.api#range": { + "min": 1, + "max": 10080 + } + } + }, + "associatedAlarms": { + "target": "com.amazonaws.arcregionswitch#AssociatedAlarmMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The alarms associated with a Region switch plan.

" + } + }, + "triggers": { + "target": "com.amazonaws.arcregionswitch#TriggerList", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The triggers associated with a Region switch plan.

" + } + }, + "name": { + "target": "com.amazonaws.arcregionswitch#PlanName", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The name of a Region switch plan.

", + "smithy.api#required": {} + } + }, + "regions": { + "target": "com.amazonaws.arcregionswitch#RegionList", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.

", + "smithy.api#required": {} + } + }, + "recoveryApproach": { + "target": "com.amazonaws.arcregionswitch#RecoveryApproach", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

", + "smithy.api#required": {} + } + }, + "primaryRegion": { + "target": "com.amazonaws.arcregionswitch#Region", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.

" + } + }, + "tags": { + "target": "com.amazonaws.arcregionswitch#Tags", + "traits": { + "smithy.api#documentation": "

The tags to apply to the Region switch plan.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#CreatePlanResponse": { + "type": "structure", + "members": { + "plan": { + "target": "com.amazonaws.arcregionswitch#Plan", + "traits": { + "smithy.api#documentation": "

The details of the created Region switch plan.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#CustomActionLambdaConfiguration": { + "type": "structure", + "members": { + "timeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 60, + "smithy.api#documentation": "

The timeout value specified for the configuration.

", + "smithy.api#range": { + "min": 1 + } + } + }, + "lambdas": { + "target": "com.amazonaws.arcregionswitch#LambdaList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Lambda functions for the execution block.

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

The retry interval specified.

", + "smithy.api#required": {} + } + }, + "regionToRun": { + "target": "com.amazonaws.arcregionswitch#RegionToRunIn", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region for the function to run in.

", + "smithy.api#required": {} + } + }, + "ungraceful": { + "target": "com.amazonaws.arcregionswitch#LambdaUngraceful", + "traits": { + "smithy.api#documentation": "

The settings for ungraceful execution.

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

Configuration for Amazon Web Services Lambda functions that perform custom actions during a Region switch.

" + } + }, + "com.amazonaws.arcregionswitch#DeletePlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#DeletePlanRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#DeletePlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#IllegalStateException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete a plan" + }, + "smithy.api#documentation": "

Deletes a Region switch plan. You must specify the ARN of the plan to delete.

You cannot delete a plan that has an active execution in progress.

", + "smithy.api#idempotent": {}, + "smithy.rules#staticContextParams": { + "UseControlPlaneEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.arcregionswitch#DeletePlanRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#DeletePlanResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#Duration": { + "type": "string", + "traits": { + "smithy.api#pattern": "^P(?!$)(\\d+Y)?(\\d+M)?(\\d+D)?(T(?=\\d)(\\d+H)?(\\d+M)?(\\d+S)?)?$" + } + }, + "com.amazonaws.arcregionswitch#Ec2AsgCapacityIncreaseConfiguration": { + "type": "structure", + "members": { + "timeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 60, + "smithy.api#documentation": "

The timeout value specified for the configuration.

", + "smithy.api#range": { + "min": 1 + } + } + }, + "asgs": { + "target": "com.amazonaws.arcregionswitch#AsgList", + "traits": { + "smithy.api#documentation": "

The EC2 Auto Scaling groups for the configuration.

", + "smithy.api#required": {} + } + }, + "ungraceful": { + "target": "com.amazonaws.arcregionswitch#Ec2Ungraceful", + "traits": { + "smithy.api#documentation": "

The settings for ungraceful execution.

" + } + }, + "targetPercent": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "

The target percentage that you specify for EC2 Auto Scaling groups.

" + } + }, + "capacityMonitoringApproach": { + "target": "com.amazonaws.arcregionswitch#Ec2AsgCapacityMonitoringApproach", + "traits": { + "smithy.api#default": "sampledMaxInLast24Hours", + "smithy.api#documentation": "

The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.

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

Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.

" + } + }, + "com.amazonaws.arcregionswitch#Ec2AsgCapacityMonitoringApproach": { + "type": "enum", + "members": { + "SAMPLED_MAX_IN_LAST_24_HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sampledMaxInLast24Hours" + } + }, + "AUTOSCALING_MAX_IN_LAST_24_HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "autoscalingMaxInLast24Hours" + } + } + } + }, + "com.amazonaws.arcregionswitch#Ec2Ungraceful": { + "type": "structure", + "members": { + "minimumSuccessPercentage": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The minimum success percentage that you specify for EC2 Auto Scaling groups.

", + "smithy.api#range": { + "min": 0, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for handling failures when performing operations on EC2 resources.

" + } + }, + "com.amazonaws.arcregionswitch#EcsCapacityIncreaseConfiguration": { + "type": "structure", + "members": { + "timeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 60, + "smithy.api#documentation": "

The timeout value specified for the configuration.

", + "smithy.api#range": { + "min": 1 + } + } + }, + "services": { + "target": "com.amazonaws.arcregionswitch#ServiceList", + "traits": { + "smithy.api#documentation": "

The services specified for the configuration.

", + "smithy.api#required": {} + } + }, + "ungraceful": { + "target": "com.amazonaws.arcregionswitch#EcsUngraceful", + "traits": { + "smithy.api#documentation": "

The settings for ungraceful execution.

" + } + }, + "targetPercent": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "

The target percentage specified for the configuration.

" + } + }, + "capacityMonitoringApproach": { + "target": "com.amazonaws.arcregionswitch#EcsCapacityMonitoringApproach", + "traits": { + "smithy.api#default": "sampledMaxInLast24Hours", + "smithy.api#documentation": "

The monitoring approach specified for the configuration, for example, Most_Recent.

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

The configuration for an Amazon Web Services ECS capacity increase.

" + } + }, + "com.amazonaws.arcregionswitch#EcsCapacityMonitoringApproach": { + "type": "enum", + "members": { + "SAMPLED_MAX_IN_LAST_24_HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sampledMaxInLast24Hours" + } + }, + "CONTAINER_INSIGHTS_MAX_IN_LAST_24_HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "containerInsightsMaxInLast24Hours" + } + } + } + }, + "com.amazonaws.arcregionswitch#EcsClusterArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:ecs:[a-z0-9-]+:\\d{12}:cluster/[a-zA-Z0-9_-]{1,255}$" + } + }, + "com.amazonaws.arcregionswitch#EcsServiceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:ecs:[a-z0-9-]+:\\d{12}:service/[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]{1,255}$" + } + }, + "com.amazonaws.arcregionswitch#EcsUngraceful": { + "type": "structure", + "members": { + "minimumSuccessPercentage": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The minimum success percentage specified for the configuration.

", + "smithy.api#range": { + "min": 0, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings for ungraceful execution.

" + } + }, + "com.amazonaws.arcregionswitch#EksCapacityMonitoringApproach": { + "type": "enum", + "members": { + "SAMPLED_MAX_IN_LAST_24_HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sampledMaxInLast24Hours" + } + } + } + }, + "com.amazonaws.arcregionswitch#EksCluster": { + "type": "structure", + "members": { + "crossAccountRole": { + "target": "com.amazonaws.arcregionswitch#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The cross account role for the configuration.

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

The external ID (secret key) for the configuration.

" + } + }, + "clusterArn": { + "target": "com.amazonaws.arcregionswitch#EksClusterArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Web Services EKS cluster.

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

The Amazon Web Services EKS cluster execution block configuration.

" + } + }, + "com.amazonaws.arcregionswitch#EksClusterArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:eks:[a-z0-9-]+:\\d{12}:cluster/[a-zA-Z0-9][a-zA-Z0-9-_]{0,99}$" + } + }, + "com.amazonaws.arcregionswitch#EksClusters": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#EksCluster" + }, + "traits": { + "smithy.api#length": { + "min": 2 + } + } + }, + "com.amazonaws.arcregionswitch#EksResourceScalingConfiguration": { + "type": "structure", + "members": { + "timeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 60, + "smithy.api#documentation": "

The timeout value specified for the configuration.

", + "smithy.api#range": { + "min": 1 + } + } + }, + "kubernetesResourceType": { + "target": "com.amazonaws.arcregionswitch#KubernetesResourceType", + "traits": { + "smithy.api#documentation": "

The Kubernetes resource type for the configuration.

", + "smithy.api#required": {} + } + }, + "scalingResources": { + "target": "com.amazonaws.arcregionswitch#KubernetesScalingApps", + "traits": { + "smithy.api#documentation": "

The scaling resources for the configuration.

" + } + }, + "eksClusters": { + "target": "com.amazonaws.arcregionswitch#EksClusters", + "traits": { + "smithy.api#documentation": "

The clusters for the configuration.

" + } + }, + "ungraceful": { + "target": "com.amazonaws.arcregionswitch#EksResourceScalingUngraceful", + "traits": { + "smithy.api#documentation": "

The settings for ungraceful execution.

" + } + }, + "targetPercent": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "

The target percentage for the configuration.

", + "smithy.api#range": { + "min": 1 + } + } + }, + "capacityMonitoringApproach": { + "target": "com.amazonaws.arcregionswitch#EksCapacityMonitoringApproach", + "traits": { + "smithy.api#default": "sampledMaxInLast24Hours", + "smithy.api#documentation": "

The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.

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

The Amazon Web Services EKS resource scaling configuration.

" + } + }, + "com.amazonaws.arcregionswitch#EksResourceScalingUngraceful": { + "type": "structure", + "members": { + "minimumSuccessPercentage": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The minimum success percentage for the configuration.

", + "smithy.api#range": { + "min": 0, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The ungraceful settings for Amazon Web Services EKS resource scaling.

" + } + }, + "com.amazonaws.arcregionswitch#EvaluationStatus": { + "type": "enum", + "members": { + "PASSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "passed" + } + }, + "ACTION_REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "actionRequired" + } + }, + "PENDING_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pendingEvaluation" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + } + } + }, + "com.amazonaws.arcregionswitch#ExecutionAction": { + "type": "enum", + "members": { + "ACTIVATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "activate" + } + }, + "DEACTIVATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deactivate" + } + } + } + }, + "com.amazonaws.arcregionswitch#ExecutionApprovalConfiguration": { + "type": "structure", + "members": { + "timeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 60, + "smithy.api#documentation": "

The timeout value specified for the configuration.

", + "smithy.api#range": { + "min": 1 + } + } + }, + "approvalRole": { + "target": "com.amazonaws.arcregionswitch#RoleArn", + "traits": { + "smithy.api#documentation": "

The IAM approval role for the configuration.

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

Configuration for approval steps in a Region switch plan execution. Approval steps require manual intervention before the execution can proceed.

" + } + }, + "com.amazonaws.arcregionswitch#ExecutionBlockConfiguration": { + "type": "union", + "members": { + "customActionLambdaConfig": { + "target": "com.amazonaws.arcregionswitch#CustomActionLambdaConfiguration", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Lambda execution block.

" + } + }, + "ec2AsgCapacityIncreaseConfig": { + "target": "com.amazonaws.arcregionswitch#Ec2AsgCapacityIncreaseConfiguration", + "traits": { + "smithy.api#documentation": "

An EC2 Auto Scaling group execution block.

" + } + }, + "executionApprovalConfig": { + "target": "com.amazonaws.arcregionswitch#ExecutionApprovalConfiguration", + "traits": { + "smithy.api#documentation": "

A manual approval execution block.

" + } + }, + "arcRoutingControlConfig": { + "target": "com.amazonaws.arcregionswitch#ArcRoutingControlConfiguration", + "traits": { + "smithy.api#documentation": "

An ARC routing control execution block.

" + } + }, + "globalAuroraConfig": { + "target": "com.amazonaws.arcregionswitch#GlobalAuroraConfiguration", + "traits": { + "smithy.api#documentation": "

An Aurora Global Database execution block.

" + } + }, + "parallelConfig": { + "target": "com.amazonaws.arcregionswitch#ParallelExecutionBlockConfiguration", + "traits": { + "smithy.api#documentation": "

A parallel configuration execution block.

" + } + }, + "regionSwitchPlanConfig": { + "target": "com.amazonaws.arcregionswitch#RegionSwitchPlanConfiguration", + "traits": { + "smithy.api#documentation": "

A Region switch plan execution block.

" + } + }, + "ecsCapacityIncreaseConfig": { + "target": "com.amazonaws.arcregionswitch#EcsCapacityIncreaseConfiguration", + "traits": { + "smithy.api#documentation": "

The capacity increase specified for the configuration.

" + } + }, + "eksResourceScalingConfig": { + "target": "com.amazonaws.arcregionswitch#EksResourceScalingConfiguration", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services EKS resource scaling execution block.

" + } + }, + "route53HealthCheckConfig": { + "target": "com.amazonaws.arcregionswitch#Route53HealthCheckConfiguration", + "traits": { + "smithy.api#documentation": "

The Amazon Route 53 health check configuration.

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

Execution block configurations for a workflow in a Region switch plan. An execution block represents a specific type of action to perform during a Region switch.

" + } + }, + "com.amazonaws.arcregionswitch#ExecutionBlockType": { + "type": "enum", + "members": { + "CUSTOM_ACTION_LAMBDA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CustomActionLambda" + } + }, + "EXECUTION_APPROVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManualApproval" + } + }, + "AURORA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AuroraGlobalDatabase" + } + }, + "EC2_ASG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2AutoScaling" + } + }, + "ROUTING_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCRoutingControl" + } + }, + "REGION_SWITCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCRegionSwitchPlan" + } + }, + "PARALLEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Parallel" + } + }, + "ECS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECSServiceScaling" + } + }, + "EKS_RESOURCE_SCALING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKSResourceScaling" + } + }, + "ROUTE53_HEALTH_CHECK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Route53HealthCheck" + } + } + } + }, + "com.amazonaws.arcregionswitch#ExecutionComment": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + } + } + }, + "com.amazonaws.arcregionswitch#ExecutionEvent": { + "type": "structure", + "members": { + "timestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for an execution event.

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

The type of an execution event.

" + } + }, + "stepName": { + "target": "com.amazonaws.arcregionswitch#StepName", + "traits": { + "smithy.api#documentation": "

The step name for an execution event.

" + } + }, + "executionBlockType": { + "target": "com.amazonaws.arcregionswitch#ExecutionBlockType", + "traits": { + "smithy.api#documentation": "

The execution block type for an execution event.

" + } + }, + "resources": { + "target": "com.amazonaws.arcregionswitch#Resources", + "traits": { + "smithy.api#documentation": "

The resources for an execution event.

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

Errors for an execution event.

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

The description for an execution event.

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

The event ID for an execution event.

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

The event ID of the previous execution event.

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

Represents an event that occurred during a plan execution. These events provide a detailed timeline of the execution process.

" + } + }, + "com.amazonaws.arcregionswitch#ExecutionEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#ExecutionEvent" + } + }, + "com.amazonaws.arcregionswitch#ExecutionEventType": { + "type": "enum", + "members": { + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + }, + "EXECUTION_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executionPending" + } + }, + "EXECUTION_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executionStarted" + } + }, + "EXECUTION_SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executionSucceeded" + } + }, + "EXECUTION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executionFailed" + } + }, + "EXECUTION_PAUSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executionPausing" + } + }, + "EXECUTION_PAUSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executionPaused" + } + }, + "EXECUTION_CANCELING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executionCanceling" + } + }, + "EXECUTION_CANCELED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executionCanceled" + } + }, + "EXECUTION_PENDING_APPROVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executionPendingApproval" + } + }, + "EXECUTION_BEHAVIOR_CHANGED_TO_UNGRACEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executionBehaviorChangedToUngraceful" + } + }, + "EXECUTION_BEHAVIOR_CHANGED_TO_GRACEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executionBehaviorChangedToGraceful" + } + }, + "EXECUTION_PENDING_CHILD_PLAN_MANUAL_APPROVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executionPendingChildPlanManualApproval" + } + }, + "EXECUTION_SUCCESS_MONITORING_APPLICATION_HEALTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "executionSuccessMonitoringApplicationHealth" + } + }, + "STEP_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stepStarted" + } + }, + "STEP_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stepUpdate" + } + }, + "STEP_SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stepSucceeded" + } + }, + "STEP_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stepFailed" + } + }, + "STEP_SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stepSkipped" + } + }, + "STEP_PAUSED_BY_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stepPausedByError" + } + }, + "STEP_PAUSED_BY_OPERATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stepPausedByOperator" + } + }, + "STEP_CANCELED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stepCanceled" + } + }, + "STEP_PENDING_APPROVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stepPendingApproval" + } + }, + "STEP_EXECUTION_BEHAVIOR_CHANGED_TO_UNGRACEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stepExecutionBehaviorChangedToUngraceful" + } + }, + "STEP_PENDING_APPLICATION_HEALTH_MONITOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stepPendingApplicationHealthMonitor" + } + } + } + }, + "com.amazonaws.arcregionswitch#ExecutionId": { + "type": "string" + }, + "com.amazonaws.arcregionswitch#ExecutionMode": { + "type": "enum", + "members": { + "GRACEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "graceful" + } + }, + "UNGRACEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ungraceful" + } + } + } + }, + "com.amazonaws.arcregionswitch#ExecutionState": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inProgress" + } + }, + "PAUSED_BY_FAILED_STEP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pausedByFailedStep" + } + }, + "PAUSED_BY_OPERATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pausedByOperator" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "COMPLETED_WITH_EXCEPTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completedWithExceptions" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "canceled" + } + }, + "PLAN_EXECUTION_TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "planExecutionTimedOut" + } + }, + "PENDING_MANUAL_APPROVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pendingManualApproval" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "COMPLETED_MONITORING_APPLICATION_HEALTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completedMonitoringApplicationHealth" + } + } + } + }, + "com.amazonaws.arcregionswitch#GetPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#GetPlanRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#GetPlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get information about a plan" + }, + "smithy.api#documentation": "

Retrieves detailed information about a Region switch plan. You must specify the ARN of the plan.

", + "smithy.api#readonly": {}, + "smithy.rules#staticContextParams": { + "UseControlPlaneEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.arcregionswitch#GetPlanEvaluationStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#GetPlanEvaluationStatusRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#GetPlanEvaluationStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#AccessDeniedException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get a plan's evaluation status" + }, + "smithy.api#documentation": "

Retrieves the evaluation status of a Region switch plan. The evaluation status provides information about the last time the plan was evaluated and any warnings or issues detected.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "warnings" + }, + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "PlanEvaluationStatusPassed": { + "minDelay": 30, + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "evaluationState", + "expected": "passed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "evaluationState", + "expected": "actionRequired", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "evaluationState", + "expected": "pendingEvaluation", + "comparator": "stringEquals" + } + } + } + ] + } + } + } + }, + "com.amazonaws.arcregionswitch#GetPlanEvaluationStatusRequest": { + "type": "structure", + "members": { + "planArn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.

", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.arcregionswitch#MaxResults", + "traits": { + "smithy.api#documentation": "

The number of objects that you want to return with this call.

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

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#GetPlanEvaluationStatusResponse": { + "type": "structure", + "members": { + "planArn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan.

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

The time of the last time that Region switch ran an evaluation of the plan.

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

The version of the last evaluation of the plan.

" + } + }, + "region": { + "target": "com.amazonaws.arcregionswitch#Region", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region for the plan.

" + } + }, + "evaluationState": { + "target": "com.amazonaws.arcregionswitch#EvaluationStatus", + "traits": { + "smithy.api#documentation": "

The evaluation state for the plan.

" + } + }, + "warnings": { + "target": "com.amazonaws.arcregionswitch#PlanWarnings", + "traits": { + "smithy.api#documentation": "

The current evaluation warnings for the plan.

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

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#GetPlanExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#GetPlanExecutionRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#GetPlanExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#AccessDeniedException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get plan execution details and setup information" + }, + "smithy.api#documentation": "

Retrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "stepStates" + }, + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "PlanExecutionCompleted": { + "minDelay": 30, + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "executionState", + "expected": "completed", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "executionState", + "expected": "completedWithExceptions", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "executionState", + "expected": "failed", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "executionState", + "expected": "canceled", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "executionState", + "expected": "planExecutionTimedOut", + "comparator": "stringEquals" + } + } + } + ] + } + } + } + }, + "com.amazonaws.arcregionswitch#GetPlanExecutionRequest": { + "type": "structure", + "members": { + "planArn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan with the execution to retrieve.

", + "smithy.api#required": {} + } + }, + "executionId": { + "target": "com.amazonaws.arcregionswitch#ExecutionId", + "traits": { + "smithy.api#documentation": "

The execution identifier of a plan execution.

", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.arcregionswitch#GetPlanExecutionStepStatesMaxResults", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "

The number of objects that you want to return with this call.

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

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#GetPlanExecutionResponse": { + "type": "structure", + "members": { + "planArn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan.

", + "smithy.api#required": {} + } + }, + "executionId": { + "target": "com.amazonaws.arcregionswitch#ExecutionId", + "traits": { + "smithy.api#documentation": "

The execution identifier of a plan execution.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "smithy.api#String", + "traits": { + "aws.cloudformation#cfnMutability": "read", + "smithy.api#documentation": "

The version for the plan.

" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The timestamp when the plan execution was last updated.

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

A comment included on the plan execution.

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

The time (UTC) when the plan execution started.

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

The time (UTC) when the plan execution ended.

" + } + }, + "mode": { + "target": "com.amazonaws.arcregionswitch#ExecutionMode", + "traits": { + "smithy.api#documentation": "

The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

", + "smithy.api#required": {} + } + }, + "executionState": { + "target": "com.amazonaws.arcregionswitch#ExecutionState", + "traits": { + "smithy.api#documentation": "

The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.

", + "smithy.api#required": {} + } + }, + "executionAction": { + "target": "com.amazonaws.arcregionswitch#ExecutionAction", + "traits": { + "smithy.api#documentation": "

The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.

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

The Amazon Web Services Region for a plan execution.

", + "smithy.api#required": {} + } + }, + "stepStates": { + "target": "com.amazonaws.arcregionswitch#StepStates", + "traits": { + "smithy.api#documentation": "

The states of the steps in the plan execution.

" + } + }, + "plan": { + "target": "com.amazonaws.arcregionswitch#Plan", + "traits": { + "smithy.api#documentation": "

The details of the Region switch plan.

" + } + }, + "actualRecoveryTime": { + "target": "com.amazonaws.arcregionswitch#Duration", + "traits": { + "smithy.api#documentation": "

The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you've specified are healthy again.

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

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#GetPlanExecutionStepStatesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.arcregionswitch#GetPlanInRegion": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#GetPlanInRegionRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#GetPlanInRegionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#AccessDeniedException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get information about a plan in a specific AWS Region using the Region switch Regional data plane" + }, + "smithy.api#documentation": "

Retrieves information about a Region switch plan in a specific Amazon Web Services Region. This operation is useful for getting Region-specific information about a plan.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.arcregionswitch#GetPlanInRegionRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan in Region.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#GetPlanInRegionResponse": { + "type": "structure", + "members": { + "plan": { + "target": "com.amazonaws.arcregionswitch#Plan", + "traits": { + "smithy.api#documentation": "

The details of the Region switch plan.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#GetPlanRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#GetPlanResponse": { + "type": "structure", + "members": { + "plan": { + "target": "com.amazonaws.arcregionswitch#Plan", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The detailed information about the requested Region switch plan.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#GlobalAuroraConfiguration": { + "type": "structure", + "members": { + "timeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 60, + "smithy.api#documentation": "

The timeout value specified for the configuration.

", + "smithy.api#range": { + "min": 1 + } + } + }, + "crossAccountRole": { + "target": "com.amazonaws.arcregionswitch#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The cross account role for the configuration.

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

The external ID (secret key) for the configuration.

" + } + }, + "behavior": { + "target": "com.amazonaws.arcregionswitch#GlobalAuroraDefaultBehavior", + "traits": { + "smithy.api#default": "switchoverOnly", + "smithy.api#documentation": "

The behavior for a global database, that is, only allow switchover or also allow failover.

", + "smithy.api#required": {} + } + }, + "ungraceful": { + "target": "com.amazonaws.arcregionswitch#GlobalAuroraUngraceful", + "traits": { + "smithy.api#documentation": "

The settings for ungraceful execution.

" + } + }, + "globalClusterIdentifier": { + "target": "com.amazonaws.arcregionswitch#GlobalClusterIdentifier", + "traits": { + "smithy.api#documentation": "

The global cluster identifier for a global database.

", + "smithy.api#required": {} + } + }, + "databaseClusterArns": { + "target": "com.amazonaws.arcregionswitch#AuroraClusterArns", + "traits": { + "smithy.api#documentation": "

The database cluster Amazon Resource Names (ARNs) for a global database.

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

Configuration for Amazon Aurora global databases used in a Region switch plan.

" + } + }, + "com.amazonaws.arcregionswitch#GlobalAuroraDefaultBehavior": { + "type": "enum", + "members": { + "SWITCHOVER_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "switchoverOnly" + } + }, + "FAILOVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failover" + } + } + } + }, + "com.amazonaws.arcregionswitch#GlobalAuroraUngraceful": { + "type": "structure", + "members": { + "ungraceful": { + "target": "com.amazonaws.arcregionswitch#GlobalAuroraUngracefulBehavior", + "traits": { + "smithy.api#documentation": "

The settings for ungraceful execution.

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

Configuration for handling failures when performing operations on Aurora global databases.

" + } + }, + "com.amazonaws.arcregionswitch#GlobalAuroraUngracefulBehavior": { + "type": "enum", + "members": { + "FAILOVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failover" + } + } + } + }, + "com.amazonaws.arcregionswitch#GlobalClusterIdentifier": { + "type": "string" + }, + "com.amazonaws.arcregionswitch#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-zA-Z0-9-]*:iam::[0-9]{12}:role/.+$" + } + }, + "com.amazonaws.arcregionswitch#IllegalArgumentException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request processing has an invalid argument.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.arcregionswitch#IllegalStateException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because the current state of the resource doesn't allow the operation to proceed.

HTTP Status Code: 400

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.arcregionswitch#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.arcregionswitch#KubernetesNamespace": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$" + } + }, + "com.amazonaws.arcregionswitch#KubernetesResourceType": { + "type": "structure", + "members": { + "apiVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The API version type for the Kubernetes resource.

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

The kind for the Kubernetes resource.

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

Defines the type of Kubernetes resource to scale in an Amazon EKS cluster.

" + } + }, + "com.amazonaws.arcregionswitch#KubernetesScalingApplication": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.arcregionswitch#RegionalScalingResource" + } + }, + "com.amazonaws.arcregionswitch#KubernetesScalingApps": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#KubernetesScalingApplication" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.arcregionswitch#KubernetesScalingResource": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.arcregionswitch#KubernetesNamespace", + "traits": { + "smithy.api#documentation": "

The namespace for the Kubernetes resource.

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

The name for the Kubernetes resource.

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

The hpaname for the Kubernetes resource.

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

Defines a Kubernetes resource to scale in an Amazon EKS cluster.

" + } + }, + "com.amazonaws.arcregionswitch#LambdaArn": { + "type": "string" + }, + "com.amazonaws.arcregionswitch#LambdaList": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#Lambdas" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.arcregionswitch#LambdaUngraceful": { + "type": "structure", + "members": { + "behavior": { + "target": "com.amazonaws.arcregionswitch#LambdaUngracefulBehavior", + "traits": { + "smithy.api#default": "skip", + "smithy.api#documentation": "

The ungraceful behavior for a Lambda function, which must be set to skip.

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

Configuration for handling failures when invoking Lambda functions.

" + } + }, + "com.amazonaws.arcregionswitch#LambdaUngracefulBehavior": { + "type": "enum", + "members": { + "SKIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "skip" + } + } + } + }, + "com.amazonaws.arcregionswitch#Lambdas": { + "type": "structure", + "members": { + "crossAccountRole": { + "target": "com.amazonaws.arcregionswitch#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The cross account role for the configuration.

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

The external ID (secret key) for the configuration.

" + } + }, + "arn": { + "target": "com.amazonaws.arcregionswitch#LambdaArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function.

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

Configuration for Amazon Web Services Lambda functions used in a Region switch plan.

" + } + }, + "com.amazonaws.arcregionswitch#ListExecutionEventsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.arcregionswitch#ListExecutionsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.arcregionswitch#ListPlanExecutionEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#ListPlanExecutionEventsRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#ListPlanExecutionEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#AccessDeniedException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list plan execution events" + }, + "smithy.api#documentation": "

Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.arcregionswitch#ListPlanExecutionEventsRequest": { + "type": "structure", + "members": { + "planArn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan.

", + "smithy.api#required": {} + } + }, + "executionId": { + "target": "com.amazonaws.arcregionswitch#ExecutionId", + "traits": { + "smithy.api#documentation": "

The execution identifier of a plan execution.

", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.arcregionswitch#ListExecutionEventsMaxResults", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "

The number of objects that you want to return with this call.

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

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + }, + "name": { + "target": "com.amazonaws.arcregionswitch#StepName", + "traits": { + "smithy.api#documentation": "

The name of the plan execution event.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#ListPlanExecutionEventsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.arcregionswitch#ExecutionEventList", + "traits": { + "smithy.api#documentation": "

The items in the plan execution event.

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

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#ListPlanExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#ListPlanExecutionsRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#ListPlanExecutionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#AccessDeniedException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list plan executions" + }, + "smithy.api#documentation": "

Lists the executions of a Region switch plan. This operation returns information about both current and historical executions.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.arcregionswitch#ListPlanExecutionsRequest": { + "type": "structure", + "members": { + "planArn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The ARN for the plan.

", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.arcregionswitch#ListExecutionsMaxResults", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "

The number of objects that you want to return with this call.

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

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + }, + "state": { + "target": "com.amazonaws.arcregionswitch#ExecutionState", + "traits": { + "smithy.api#documentation": "

The state of the plan execution. For example, the plan execution might be In Progress.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#ListPlanExecutionsResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.arcregionswitch#AbbreviatedExecutionsList", + "traits": { + "smithy.api#documentation": "

The items in the plan execution to return.

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

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#ListPlans": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#ListPlansRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#ListPlansResponse" + }, + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list plans" + }, + "smithy.api#documentation": "

Lists all Region switch plans in your Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "plans" + }, + "smithy.api#readonly": {}, + "smithy.rules#staticContextParams": { + "UseControlPlaneEndpoint": { + "value": true + } + }, + "smithy.test#smokeTests": [ + { + "id": "ListPlansSuccess", + "params": {}, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.arcregionswitch#ListPlansInRegion": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#ListPlansInRegionRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#ListPlansInRegionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#AccessDeniedException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list plans in a specific AWS Region using the Region switch Regional data plane" + }, + "smithy.api#documentation": "

Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "plans" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.arcregionswitch#ListPlansInRegionRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.arcregionswitch#MaxResults", + "traits": { + "smithy.api#documentation": "

The number of objects that you want to return with this call.

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

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#ListPlansInRegionResponse": { + "type": "structure", + "members": { + "plans": { + "target": "com.amazonaws.arcregionswitch#PlanList", + "traits": { + "smithy.api#documentation": "

The plans that were requested.

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

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#ListPlansRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.arcregionswitch#MaxResults", + "traits": { + "smithy.api#documentation": "

The number of objects that you want to return with this call.

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

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#ListPlansResponse": { + "type": "structure", + "members": { + "plans": { + "target": "com.amazonaws.arcregionswitch#PlanList", + "traits": { + "smithy.api#documentation": "

The plans that were requested.

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

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#ListRoute53HealthChecks": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#ListRoute53HealthChecksRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#ListRoute53HealthChecksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#AccessDeniedException" + }, + { + "target": "com.amazonaws.arcregionswitch#InternalServerException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Lists Route 53 health checks created by ARC region switch for a given plan" + }, + "smithy.api#documentation": "

List the Amazon Route 53 health checks.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "healthChecks" + }, + "smithy.api#readonly": {}, + "smithy.rules#staticContextParams": { + "UseControlPlaneEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.arcregionswitch#ListRoute53HealthChecksRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Route 53 health check request.

", + "smithy.api#required": {} + } + }, + "hostedZoneId": { + "target": "com.amazonaws.arcregionswitch#Route53HostedZoneId", + "traits": { + "smithy.api#documentation": "

The hosted zone ID for the health checks.

" + } + }, + "recordName": { + "target": "com.amazonaws.arcregionswitch#Route53RecordName", + "traits": { + "smithy.api#documentation": "

The record name for the health checks.

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

The number of objects that you want to return with this call.

", + "smithy.api#range": { + "min": 10, + "max": 100 + } + } + }, + "nextToken": { + "target": "com.amazonaws.arcregionswitch#NextToken", + "traits": { + "smithy.api#documentation": "

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#ListRoute53HealthChecksResponse": { + "type": "structure", + "members": { + "healthChecks": { + "target": "com.amazonaws.arcregionswitch#Route53HealthCheckList", + "traits": { + "smithy.api#documentation": "

List of the health checks requested.

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

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#InternalServerException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to list tags for a resource" + }, + "smithy.api#documentation": "

Lists the tags attached to a Region switch resource.

", + "smithy.api#readonly": {}, + "smithy.rules#staticContextParams": { + "UseControlPlaneEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.arcregionswitch#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "resourceTags": { + "target": "com.amazonaws.arcregionswitch#Tags", + "traits": { + "smithy.api#documentation": "

The tags for a resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.arcregionswitch#MinimalWorkflow": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.arcregionswitch#ExecutionAction", + "traits": { + "smithy.api#documentation": "

The action for a minimal workflow, which can be Activate or Deactivate.

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

The name for a minimal workflow

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

A simplified representation of a workflow in a Region switch plan.

" + } + }, + "com.amazonaws.arcregionswitch#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.arcregionswitch#ParallelExecutionBlockConfiguration": { + "type": "structure", + "members": { + "steps": { + "target": "com.amazonaws.arcregionswitch#Steps", + "traits": { + "smithy.api#documentation": "

The steps for a parallel execution block.

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

Configuration for steps that should be executed in parallel during a Region switch.

" + } + }, + "com.amazonaws.arcregionswitch#Plan": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The description for a plan.

" + } + }, + "workflows": { + "target": "com.amazonaws.arcregionswitch#WorkflowList", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The workflows for a plan.

", + "smithy.api#required": {} + } + }, + "executionRole": { + "target": "com.amazonaws.arcregionswitch#IamRoleArn", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The execution role for a plan.

", + "smithy.api#required": {} + } + }, + "recoveryTimeObjectiveMinutes": { + "target": "smithy.api#Integer", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The recovery time objective for a plan.

", + "smithy.api#range": { + "min": 1, + "max": 10080 + } + } + }, + "associatedAlarms": { + "target": "com.amazonaws.arcregionswitch#AssociatedAlarmMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The associated application health alarms for a plan.

" + } + }, + "triggers": { + "target": "com.amazonaws.arcregionswitch#TriggerList", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The triggers for a plan.

" + } + }, + "name": { + "target": "com.amazonaws.arcregionswitch#PlanName", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The name for a plan.

", + "smithy.api#required": {} + } + }, + "regions": { + "target": "com.amazonaws.arcregionswitch#RegionList", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The Amazon Web Services Regions for a plan.

", + "smithy.api#required": {} + } + }, + "recoveryApproach": { + "target": "com.amazonaws.arcregionswitch#RecoveryApproach", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

", + "smithy.api#required": {} + } + }, + "primaryRegion": { + "target": "com.amazonaws.arcregionswitch#Region", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "

The primary Region for a plan.

" + } + }, + "owner": { + "target": "com.amazonaws.arcregionswitch#AccountId", + "traits": { + "aws.cloudformation#cfnMutability": "read", + "smithy.api#documentation": "

The owner of a plan.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "smithy.api#String", + "traits": { + "aws.cloudformation#cfnMutability": "read", + "smithy.api#documentation": "

The version for the plan.

" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The timestamp when the plan was last updated.

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

Represents a Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.

" + } + }, + "com.amazonaws.arcregionswitch#PlanArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6})$" + } + }, + "com.amazonaws.arcregionswitch#PlanList": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#AbbreviatedPlan" + } + }, + "com.amazonaws.arcregionswitch#PlanName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?$" + } + }, + "com.amazonaws.arcregionswitch#PlanWarnings": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#ResourceWarning" + } + }, + "com.amazonaws.arcregionswitch#RecoveryApproach": { + "type": "enum", + "members": { + "ACTIVE_ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "activeActive" + } + }, + "ACTIVE_PASSIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "activePassive" + } + } + } + }, + "com.amazonaws.arcregionswitch#Region": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z]{2}-[a-z-]+-\\d+$" + } + }, + "com.amazonaws.arcregionswitch#RegionAndRoutingControls": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.arcregionswitch#ArcRoutingControlStates" + } + }, + "com.amazonaws.arcregionswitch#RegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#Region" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.arcregionswitch#RegionSwitchPlan": { + "type": "resource", + "identifiers": { + "arn": { + "target": "com.amazonaws.arcregionswitch#PlanArn" + } + }, + "create": { + "target": "com.amazonaws.arcregionswitch#CreatePlan" + }, + "read": { + "target": "com.amazonaws.arcregionswitch#GetPlan" + }, + "update": { + "target": "com.amazonaws.arcregionswitch#UpdatePlan" + }, + "delete": { + "target": "com.amazonaws.arcregionswitch#DeletePlan" + }, + "list": { + "target": "com.amazonaws.arcregionswitch#ListPlans" + }, + "operations": [ + { + "target": "com.amazonaws.arcregionswitch#ListTagsForResource" + }, + { + "target": "com.amazonaws.arcregionswitch#TagResource" + }, + { + "target": "com.amazonaws.arcregionswitch#UntagResource" + } + ], + "traits": { + "aws.api#arn": { + "template": "plan/{arn}" + }, + "aws.cloudformation#cfnResource": { + "name": "Plan", + "additionalSchemas": [ + "com.amazonaws.arcregionswitch#Plan" + ] + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "plan", + "relativeDocumentation": "plan.html" + } + } + }, + "com.amazonaws.arcregionswitch#RegionSwitchPlanConfiguration": { + "type": "structure", + "members": { + "crossAccountRole": { + "target": "com.amazonaws.arcregionswitch#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The cross account role for the configuration.

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

The external ID (secret key) for the configuration.

" + } + }, + "arn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan configuration.

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

Configuration for nested Region switch plans. This allows one Region switch plan to trigger another plan as part of its execution.

" + } + }, + "com.amazonaws.arcregionswitch#RegionToRunIn": { + "type": "enum", + "members": { + "ACTIVATING_REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "activatingRegion" + } + }, + "DEACTIVATING_REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deactivatingRegion" + } + } + } + }, + "com.amazonaws.arcregionswitch#RegionalScalingResource": { + "type": "map", + "key": { + "target": "com.amazonaws.arcregionswitch#Region" + }, + "value": { + "target": "com.amazonaws.arcregionswitch#KubernetesScalingResource" + } + }, + "com.amazonaws.arcregionswitch#ResourceArn": { + "type": "string" + }, + "com.amazonaws.arcregionswitch#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource was not found.

HTTP Status Code: 404

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.arcregionswitch#ResourceWarning": { + "type": "structure", + "members": { + "workflow": { + "target": "com.amazonaws.arcregionswitch#MinimalWorkflow", + "traits": { + "smithy.api#documentation": "

The workflow for the resource warning.

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

The version for the resource warning.

", + "smithy.api#required": {} + } + }, + "stepName": { + "target": "com.amazonaws.arcregionswitch#StepName", + "traits": { + "smithy.api#documentation": "

The name of the step for the resource warning.

" + } + }, + "resourceArn": { + "target": "com.amazonaws.arcregionswitch#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "warningStatus": { + "target": "com.amazonaws.arcregionswitch#ResourceWarningStatus", + "traits": { + "smithy.api#documentation": "

The status of the resource warning.

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

The timestamp when the warning was last updated.

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

The warning message about what needs to be corrected.

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

Represents a warning about a resource in a Region switch plan.

" + } + }, + "com.amazonaws.arcregionswitch#ResourceWarningStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "RESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resolved" + } + } + } + }, + "com.amazonaws.arcregionswitch#Resources": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.arcregionswitch#RoleArn": { + "type": "string" + }, + "com.amazonaws.arcregionswitch#Route53HealthCheck": { + "type": "structure", + "members": { + "hostedZoneId": { + "target": "com.amazonaws.arcregionswitch#Route53HostedZoneId", + "traits": { + "smithy.api#documentation": "

The Amazon Route 53 health check hosted zone ID.

", + "smithy.api#required": {} + } + }, + "recordName": { + "target": "com.amazonaws.arcregionswitch#Route53RecordName", + "traits": { + "smithy.api#documentation": "

The Amazon Route 53 record name.

", + "smithy.api#required": {} + } + }, + "healthCheckId": { + "target": "com.amazonaws.arcregionswitch#Route53HealthCheckId", + "traits": { + "smithy.api#documentation": "

The Amazon Route 53 health check ID.

" + } + }, + "region": { + "target": "com.amazonaws.arcregionswitch#Region", + "traits": { + "smithy.api#documentation": "

The Amazon Route 53 Region.

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

The Amazon Route 53 health check.

" + } + }, + "com.amazonaws.arcregionswitch#Route53HealthCheckConfiguration": { + "type": "structure", + "members": { + "timeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": 60, + "smithy.api#documentation": "

The Amazon Route 53 health check configuration time out (in minutes).

", + "smithy.api#range": { + "min": 1 + } + } + }, + "crossAccountRole": { + "target": "com.amazonaws.arcregionswitch#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The cross account role for the configuration.

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

The external ID (secret key) for the configuration.

" + } + }, + "hostedZoneId": { + "target": "com.amazonaws.arcregionswitch#Route53HostedZoneId", + "traits": { + "smithy.api#documentation": "

The Amazon Route 53 health check configuration hosted zone ID.

", + "smithy.api#required": {} + } + }, + "recordName": { + "target": "com.amazonaws.arcregionswitch#Route53RecordName", + "traits": { + "smithy.api#documentation": "

The Amazon Route 53 health check configuration record name.

", + "smithy.api#required": {} + } + }, + "recordSets": { + "target": "com.amazonaws.arcregionswitch#Route53ResourceRecordSetList", + "traits": { + "smithy.api#documentation": "

The Amazon Route 53 health check configuration record sets.

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

The Amazon Route 53 health check configuration.

" + } + }, + "com.amazonaws.arcregionswitch#Route53HealthCheckId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.arcregionswitch#Route53HealthCheckList": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#Route53HealthCheck" + } + }, + "com.amazonaws.arcregionswitch#Route53HostedZoneId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.arcregionswitch#Route53RecordName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.arcregionswitch#Route53ResourceRecordSet": { + "type": "structure", + "members": { + "recordSetIdentifier": { + "target": "com.amazonaws.arcregionswitch#Route53ResourceRecordSetIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Route 53 record set identifier.

" + } + }, + "region": { + "target": "com.amazonaws.arcregionswitch#Region", + "traits": { + "smithy.api#documentation": "

The Amazon Route 53 record set Region.

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

The Amazon Route 53 record set.

" + } + }, + "com.amazonaws.arcregionswitch#Route53ResourceRecordSetIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.arcregionswitch#Route53ResourceRecordSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#Route53ResourceRecordSet" + } + }, + "com.amazonaws.arcregionswitch#RoutingControlArn": { + "type": "string" + }, + "com.amazonaws.arcregionswitch#RoutingControlStateChange": { + "type": "enum", + "members": { + "ON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "On" + } + }, + "OFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Off" + } + } + } + }, + "com.amazonaws.arcregionswitch#Service": { + "type": "structure", + "members": { + "crossAccountRole": { + "target": "com.amazonaws.arcregionswitch#IamRoleArn", + "traits": { + "smithy.api#documentation": "

The cross account role for a service.

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

The external ID (secret key) for the service.

" + } + }, + "clusterArn": { + "target": "com.amazonaws.arcregionswitch#EcsClusterArn", + "traits": { + "smithy.api#documentation": "

The cluster Amazon Resource Name (ARN) for a service.

" + } + }, + "serviceArn": { + "target": "com.amazonaws.arcregionswitch#EcsServiceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a service.

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

The service for a cross account role.

" + } + }, + "com.amazonaws.arcregionswitch#ServiceList": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#Service" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.arcregionswitch#StartPlanExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#StartPlanExecutionRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#StartPlanExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#AccessDeniedException" + }, + { + "target": "com.amazonaws.arcregionswitch#IllegalArgumentException" + }, + { + "target": "com.amazonaws.arcregionswitch#IllegalStateException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to start a plan execution" + }, + "smithy.api#documentation": "

Starts the execution of a Region switch plan. You can execute a plan in either PRACTICE or RECOVERY mode.

In PRACTICE mode, the execution simulates the steps without making actual changes to your application's traffic routing. In RECOVERY mode, the execution performs actual changes to shift traffic between Regions.

" + } + }, + "com.amazonaws.arcregionswitch#StartPlanExecutionRequest": { + "type": "structure", + "members": { + "planArn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan to execute.

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

The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.

", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.arcregionswitch#ExecutionAction", + "traits": { + "smithy.api#documentation": "

The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).

", + "smithy.api#required": {} + } + }, + "mode": { + "target": "com.amazonaws.arcregionswitch#ExecutionMode", + "traits": { + "smithy.api#default": "graceful", + "smithy.api#documentation": "

The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.

" + } + }, + "comment": { + "target": "com.amazonaws.arcregionswitch#ExecutionComment", + "traits": { + "smithy.api#documentation": "

An optional comment explaining why the plan execution is being started.

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

A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#StartPlanExecutionResponse": { + "type": "structure", + "members": { + "executionId": { + "target": "com.amazonaws.arcregionswitch#ExecutionId", + "traits": { + "smithy.api#documentation": "

The execution identifier of a plan execution.

" + } + }, + "plan": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The details of the Region switch plan.

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

The version of the plan, a unique number generated by Region switch.

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

The Amazon Web Services Region to activate.

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

The Amazon Web Services Region to deactivate.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#Step": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.arcregionswitch#StepName", + "traits": { + "smithy.api#documentation": "

The name of a step in a workflow.

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

The description of a step in a workflow.

" + } + }, + "executionBlockConfiguration": { + "target": "com.amazonaws.arcregionswitch#ExecutionBlockConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for an execution block in a workflow.

", + "smithy.api#required": {} + } + }, + "executionBlockType": { + "target": "com.amazonaws.arcregionswitch#ExecutionBlockType", + "traits": { + "smithy.api#documentation": "

The type of an execution block in a workflow.

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

Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.

" + } + }, + "com.amazonaws.arcregionswitch#StepName": { + "type": "string" + }, + "com.amazonaws.arcregionswitch#StepState": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.arcregionswitch#StepName", + "traits": { + "smithy.api#documentation": "

The name of a step in a workflow.

" + } + }, + "status": { + "target": "com.amazonaws.arcregionswitch#StepStatus", + "traits": { + "smithy.api#documentation": "

The status of a step in a workflow. For example, a status might be Completed or Pending Approval.

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

The timestamp when a step started execution.

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

The timestamp when a step endeded execution.

" + } + }, + "stepMode": { + "target": "com.amazonaws.arcregionswitch#ExecutionMode", + "traits": { + "smithy.api#documentation": "

The mode for a step execution. The mode can be Graceful or Ungraceful.

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

Represents the state of a step in a plan execution.

" + } + }, + "com.amazonaws.arcregionswitch#StepStates": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#StepState" + } + }, + "com.amazonaws.arcregionswitch#StepStatus": { + "type": "enum", + "members": { + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "notStarted" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "running" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "canceled" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "skipped" + } + }, + "PENDING_APPROVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pendingApproval" + } + } + } + }, + "com.amazonaws.arcregionswitch#Steps": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#Step" + } + }, + "com.amazonaws.arcregionswitch#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.arcregionswitch#TagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.arcregionswitch#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#InternalServerException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}", + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to tag a resource" + }, + "smithy.api#documentation": "

Adds or updates tags for a Region switch resource. You can assign metadata to your resources in the form of tags, which are key-value pairs.

", + "smithy.rules#staticContextParams": { + "UseControlPlaneEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.arcregionswitch#TagResourceRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a tag that you add to a resource.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.arcregionswitch#Tags", + "traits": { + "smithy.api#documentation": "

Tags that you add to a resource. You can add a maximum of 50 tags in Region switch.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.arcregionswitch#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.arcregionswitch#TagKey" + }, + "value": { + "target": "com.amazonaws.arcregionswitch#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.arcregionswitch#Trigger": { + "type": "structure", + "members": { + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The description for a trigger.

" + } + }, + "targetRegion": { + "target": "com.amazonaws.arcregionswitch#Region", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region for a trigger.

", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.arcregionswitch#WorkflowTargetAction", + "traits": { + "smithy.api#documentation": "

The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.

", + "smithy.api#required": {} + } + }, + "conditions": { + "target": "com.amazonaws.arcregionswitch#TriggerConditionList", + "traits": { + "smithy.api#documentation": "

The conditions that must be met for the trigger to fire.

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

The minimum time, in minutes, that must elapse between automatic executions of the plan.

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

Defines a condition that can automatically trigger the execution of a Region switch plan.

" + } + }, + "com.amazonaws.arcregionswitch#TriggerCondition": { + "type": "structure", + "members": { + "associatedAlarmName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch alarm associated with the condition.

", + "smithy.api#required": {} + } + }, + "condition": { + "target": "com.amazonaws.arcregionswitch#AlarmCondition", + "traits": { + "smithy.api#documentation": "

The condition that must be met. Valid values include ALARM and OK.

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

Defines a condition that must be met for a trigger to fire.

" + } + }, + "com.amazonaws.arcregionswitch#TriggerConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#TriggerCondition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.arcregionswitch#TriggerList": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#Trigger" + } + }, + "com.amazonaws.arcregionswitch#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#InternalServerException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}", + "aws:TagKeys" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to remove tags from a resource" + }, + "smithy.api#documentation": "

Removes tags from a Region switch resource.

", + "smithy.rules#staticContextParams": { + "UseControlPlaneEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.arcregionswitch#UntagResourceRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a tag you remove a resource from.

", + "smithy.api#required": {} + } + }, + "resourceTagKeys": { + "target": "com.amazonaws.arcregionswitch#TagKeys", + "traits": { + "smithy.api#documentation": "

Tag keys that you remove from a resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#UpdatePlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#UpdatePlanRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#UpdatePlanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update a plan" + }, + "smithy.api#documentation": "

Updates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers.

", + "smithy.rules#staticContextParams": { + "UseControlPlaneEndpoint": { + "value": true + } + } + } + }, + "com.amazonaws.arcregionswitch#UpdatePlanExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#UpdatePlanExecutionRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#UpdatePlanExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#AccessDeniedException" + }, + { + "target": "com.amazonaws.arcregionswitch#IllegalStateException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update a plan execution" + }, + "smithy.api#documentation": "

Updates an in-progress plan execution. This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action.

" + } + }, + "com.amazonaws.arcregionswitch#UpdatePlanExecutionAction": { + "type": "enum", + "members": { + "SWITCH_TO_GRACEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "switchToGraceful" + } + }, + "SWITCH_TO_UNGRACEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "switchToUngraceful" + } + }, + "PAUSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pause" + } + }, + "RESUME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resume" + } + } + } + }, + "com.amazonaws.arcregionswitch#UpdatePlanExecutionRequest": { + "type": "structure", + "members": { + "planArn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan with the execution to update.

", + "smithy.api#required": {} + } + }, + "executionId": { + "target": "com.amazonaws.arcregionswitch#ExecutionId", + "traits": { + "smithy.api#documentation": "

The execution identifier of a plan execution.

", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.arcregionswitch#UpdatePlanExecutionAction", + "traits": { + "smithy.api#documentation": "

The action specified for a plan execution, for example, Switch to Graceful or Pause.

", + "smithy.api#required": {} + } + }, + "comment": { + "target": "com.amazonaws.arcregionswitch#ExecutionComment", + "traits": { + "smithy.api#documentation": "

An optional comment about the plan execution.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#UpdatePlanExecutionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#UpdatePlanExecutionStep": { + "type": "operation", + "input": { + "target": "com.amazonaws.arcregionswitch#UpdatePlanExecutionStepRequest" + }, + "output": { + "target": "com.amazonaws.arcregionswitch#UpdatePlanExecutionStepResponse" + }, + "errors": [ + { + "target": "com.amazonaws.arcregionswitch#AccessDeniedException" + }, + { + "target": "com.amazonaws.arcregionswitch#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update a plan execution step" + }, + "smithy.api#documentation": "

Updates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action.

" + } + }, + "com.amazonaws.arcregionswitch#UpdatePlanExecutionStepAction": { + "type": "enum", + "members": { + "SWITCH_TO_UNGRACEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "switchToUngraceful" + } + }, + "SKIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "skip" + } + } + } + }, + "com.amazonaws.arcregionswitch#UpdatePlanExecutionStepRequest": { + "type": "structure", + "members": { + "planArn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan containing the execution step to update.

", + "smithy.api#required": {} + } + }, + "executionId": { + "target": "com.amazonaws.arcregionswitch#ExecutionId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the plan execution containing the step to update.

", + "smithy.api#required": {} + } + }, + "comment": { + "target": "com.amazonaws.arcregionswitch#ExecutionComment", + "traits": { + "smithy.api#documentation": "

An optional comment about the plan execution.

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

The name of the execution step to update.

", + "smithy.api#required": {} + } + }, + "actionToTake": { + "target": "com.amazonaws.arcregionswitch#UpdatePlanExecutionStepAction", + "traits": { + "smithy.api#documentation": "

The updated action to take for the step. This can be used to skip or retry a step.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#UpdatePlanExecutionStepResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#UpdatePlanRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.arcregionswitch#PlanArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the plan.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The updated description for the Region switch plan.

" + } + }, + "workflows": { + "target": "com.amazonaws.arcregionswitch#WorkflowList", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The updated workflows for the Region switch plan.

", + "smithy.api#required": {} + } + }, + "executionRole": { + "target": "com.amazonaws.arcregionswitch#IamRoleArn", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.

", + "smithy.api#required": {} + } + }, + "recoveryTimeObjectiveMinutes": { + "target": "smithy.api#Integer", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The updated target recovery time objective (RTO) in minutes for the plan.

", + "smithy.api#range": { + "min": 1, + "max": 10080 + } + } + }, + "associatedAlarms": { + "target": "com.amazonaws.arcregionswitch#AssociatedAlarmMap", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The updated CloudWatch alarms associated with the plan.

" + } + }, + "triggers": { + "target": "com.amazonaws.arcregionswitch#TriggerList", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The updated conditions that can automatically trigger the execution of the plan.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.arcregionswitch#UpdatePlanResponse": { + "type": "structure", + "members": { + "plan": { + "target": "com.amazonaws.arcregionswitch#Plan", + "traits": { + "smithy.api#documentation": "

The details of the updated Region switch plan.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.arcregionswitch#Workflow": { + "type": "structure", + "members": { + "steps": { + "target": "com.amazonaws.arcregionswitch#Steps", + "traits": { + "smithy.api#documentation": "

The steps that make up the workflow.

" + } + }, + "workflowTargetAction": { + "target": "com.amazonaws.arcregionswitch#WorkflowTargetAction", + "traits": { + "smithy.api#documentation": "

The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.

", + "smithy.api#required": {} + } + }, + "workflowTargetRegion": { + "target": "com.amazonaws.arcregionswitch#Region", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region that the workflow targets.

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

The description of the workflow.

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

Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.

" + } + }, + "com.amazonaws.arcregionswitch#WorkflowList": { + "type": "list", + "member": { + "target": "com.amazonaws.arcregionswitch#Workflow" + } + }, + "com.amazonaws.arcregionswitch#WorkflowTargetAction": { + "type": "enum", + "members": { + "ACTIVATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "activate" + } + }, + "DEACTIVATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deactivate" + } + } + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/auditmanager.json b/codegen/sdk/aws-models/auditmanager.json index 3b23210a8e2..2df4cbf4867 100644 --- a/codegen/sdk/aws-models/auditmanager.json +++ b/codegen/sdk/aws-models/auditmanager.json @@ -3574,7 +3574,7 @@ "controlSets": { "target": "com.amazonaws.auditmanager#CreateAssessmentFrameworkControlSets", "traits": { - "smithy.api#documentation": "

The control sets that are associated with the framework.

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

The control sets that are associated with the framework.

\n \n

The Controls object returns a partial response when called through Framework\n APIs. For a complete Controls object, use GetControl.

\n ", "smithy.api#required": {} } }, @@ -3595,7 +3595,7 @@ "framework": { "target": "com.amazonaws.auditmanager#Framework", "traits": { - "smithy.api#documentation": "

The name of the new framework that the CreateAssessmentFramework API\n returned.

" + "smithy.api#documentation": "

The new framework object that the CreateAssessmentFramework API returned.

" } } }, @@ -5053,13 +5053,17 @@ "controlSources": { "target": "com.amazonaws.auditmanager#ControlSources", "traits": { - "smithy.api#documentation": "

The control data sources where Audit Manager collects evidence from.

" + "smithy.api#deprecated": { + "since": "2025-07-24", + "message": "Use controlSources from the Control" + }, + "smithy.api#documentation": "

The control data sources where Audit Manager collects evidence from.

\n \n

This API parameter is no longer supported.

\n " } }, "controlSets": { "target": "com.amazonaws.auditmanager#ControlSets", "traits": { - "smithy.api#documentation": "

The control sets that are associated with the framework.

" + "smithy.api#documentation": "

The control sets that are associated with the framework.

\n \n

The Controls object returns a partial response when called through\n Framework APIs. For a complete Controls object, use\n GetControl.

\n " } }, "createdAt": { @@ -5309,7 +5313,7 @@ "framework": { "target": "com.amazonaws.auditmanager#Framework", "traits": { - "smithy.api#documentation": "

The framework that the GetAssessmentFramework API returned.

" + "smithy.api#documentation": "

The framework that the GetAssessmentFramework API returned.

\n \n

The Controls object returns a partial response when called through\n Framework APIs. For a complete Controls object, use\n GetControl.

\n " } } }, @@ -7895,6 +7899,9 @@ { "target": "com.amazonaws.auditmanager#ResourceNotFoundException" }, + { + "target": "com.amazonaws.auditmanager#ThrottlingException" + }, { "target": "com.amazonaws.auditmanager#ValidationException" } @@ -8060,7 +8067,7 @@ "min": 1, "max": 1024 }, - "smithy.api#pattern": "^(S|s)3:\\/\\/[a-zA-Z0-9\\-\\.\\(\\)\\'\\*\\_\\!\\/]+$" + "smithy.api#pattern": "^(S|s)3:\\/\\/[a-zA-Z0-9\\-\\.\\(\\)\\'\\*\\_\\!\\=\\+\\@\\:\\s\\,\\?\\/]+$" } }, "com.amazonaws.auditmanager#SNSTopic": { @@ -9073,6 +9080,9 @@ { "target": "com.amazonaws.auditmanager#ResourceNotFoundException" }, + { + "target": "com.amazonaws.auditmanager#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.auditmanager#ValidationException" } @@ -9158,7 +9168,7 @@ "controlSets": { "target": "com.amazonaws.auditmanager#UpdateAssessmentFrameworkControlSets", "traits": { - "smithy.api#documentation": "

The control sets that are associated with the framework.

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

The control sets that are associated with the framework.

\n \n

The Controls object returns a partial response when called through Framework\n APIs. For a complete Controls object, use GetControl.

\n ", "smithy.api#required": {} } } @@ -9173,7 +9183,7 @@ "framework": { "target": "com.amazonaws.auditmanager#Framework", "traits": { - "smithy.api#documentation": "

The name of the framework.

" + "smithy.api#documentation": "

The framework object.

" } } }, diff --git a/codegen/sdk/aws-models/batch.json b/codegen/sdk/aws-models/batch.json index 0f61505e170..2a5f847d9a6 100644 --- a/codegen/sdk/aws-models/batch.json +++ b/codegen/sdk/aws-models/batch.json @@ -48,6 +48,9 @@ { "target": "com.amazonaws.batch#CreateSchedulingPolicy" }, + { + "target": "com.amazonaws.batch#CreateServiceEnvironment" + }, { "target": "com.amazonaws.batch#DeleteComputeEnvironment" }, @@ -60,6 +63,9 @@ { "target": "com.amazonaws.batch#DeleteSchedulingPolicy" }, + { + "target": "com.amazonaws.batch#DeleteServiceEnvironment" + }, { "target": "com.amazonaws.batch#DeregisterJobDefinition" }, @@ -81,6 +87,12 @@ { "target": "com.amazonaws.batch#DescribeSchedulingPolicies" }, + { + "target": "com.amazonaws.batch#DescribeServiceEnvironments" + }, + { + "target": "com.amazonaws.batch#DescribeServiceJob" + }, { "target": "com.amazonaws.batch#GetJobQueueSnapshot" }, @@ -96,6 +108,9 @@ { "target": "com.amazonaws.batch#ListSchedulingPolicies" }, + { + "target": "com.amazonaws.batch#ListServiceJobs" + }, { "target": "com.amazonaws.batch#ListTagsForResource" }, @@ -105,12 +120,18 @@ { "target": "com.amazonaws.batch#SubmitJob" }, + { + "target": "com.amazonaws.batch#SubmitServiceJob" + }, { "target": "com.amazonaws.batch#TagResource" }, { "target": "com.amazonaws.batch#TerminateJob" }, + { + "target": "com.amazonaws.batch#TerminateServiceJob" + }, { "target": "com.amazonaws.batch#UntagResource" }, @@ -125,6 +146,9 @@ }, { "target": "com.amazonaws.batch#UpdateSchedulingPolicy" + }, + { + "target": "com.amazonaws.batch#UpdateServiceEnvironment" } ], "traits": { @@ -1657,6 +1681,32 @@ "smithy.api#output": {} } }, + "com.amazonaws.batch#CapacityLimit": { + "type": "structure", + "members": { + "maxCapacity": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The maximum capacity available for the service environment. This value represents the maximum amount of resources that can be allocated to service jobs.

\n

For example, maxCapacity=50, capacityUnit=NUM_INSTANCES. This indicates that the\n maximum number of instances that can be run on this service environment is 50. You could\n then run 5 SageMaker Training jobs that each use 10 instances. However, if you submit another job that\n requires 10 instances, it will wait in the queue.

" + } + }, + "capacityUnit": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The unit of measure for the capacity limit. This defines how the maxCapacity value should be interpreted. For SAGEMAKER_TRAINING jobs, use NUM_INSTANCES.

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

Defines the capacity limit for a service environment. This structure specifies the maximum amount of resources that can be used by service jobs in the environment.

" + } + }, + "com.amazonaws.batch#CapacityLimits": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#CapacityLimit" + } + }, "com.amazonaws.batch#ClientException": { "type": "structure", "members": { @@ -2953,9 +3003,19 @@ "computeEnvironmentOrder": { "target": "com.amazonaws.batch#ComputeEnvironmentOrders", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The set of compute environments mapped to a job queue and their order relative to each\n other. The job scheduler uses this parameter to determine which compute environment runs a\n specific job. Compute environments must be in the VALID state before you can\n associate them with a job queue. You can associate up to three compute environments with a job\n queue. All of the compute environments must be either EC2 (EC2 or\n SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and\n Fargate compute environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same\n architecture. Batch doesn't support mixing compute environment architecture types in a\n single job queue.

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

The set of compute environments mapped to a job queue and their order relative to each\n other. The job scheduler uses this parameter to determine which compute environment runs a\n specific job. Compute environments must be in the VALID state before you can\n associate them with a job queue. You can associate up to three compute environments with a job\n queue. All of the compute environments must be either EC2 (EC2 or\n SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and\n Fargate compute environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same\n architecture. Batch doesn't support mixing compute environment architecture types in a\n single job queue.

\n " + } + }, + "serviceEnvironmentOrder": { + "target": "com.amazonaws.batch#ServiceEnvironmentOrders", + "traits": { + "smithy.api#documentation": "

A list of service environments that this job queue can use to allocate jobs. All serviceEnvironments must have the same type. A job queue can't have both a serviceEnvironmentOrder and a computeEnvironmentOrder field.

" + } + }, + "jobQueueType": { + "target": "com.amazonaws.batch#JobQueueType", + "traits": { + "smithy.api#documentation": "

The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS, or ECS_FARGATE depending on the compute environment.

" } }, "tags": { @@ -3078,6 +3138,99 @@ "smithy.api#output": {} } }, + "com.amazonaws.batch#CreateServiceEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#CreateServiceEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.batch#CreateServiceEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a service environment for running service jobs. Service environments define capacity limits for specific service types such as SageMaker Training jobs.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/createserviceenvironment", + "code": 200 + } + } + }, + "com.amazonaws.batch#CreateServiceEnvironmentRequest": { + "type": "structure", + "members": { + "serviceEnvironmentName": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name for the service environment. It can be up to 128 characters long and can contain letters, numbers, hyphens (-), and underscores (_).

", + "smithy.api#required": {} + } + }, + "serviceEnvironmentType": { + "target": "com.amazonaws.batch#ServiceEnvironmentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of service environment. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.batch#ServiceEnvironmentState", + "traits": { + "smithy.api#documentation": "

The state of the service environment. Valid values are ENABLED and DISABLED. The default value is ENABLED.

" + } + }, + "capacityLimits": { + "target": "com.amazonaws.batch#CapacityLimits", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The capacity limits for the service environment. The number of instances a job consumes is the total number of instances requested in the submit training job request resource configuration.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", + "traits": { + "smithy.api#documentation": "

The tags that you apply to the service environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.batch#CreateServiceEnvironmentResponse": { + "type": "structure", + "members": { + "serviceEnvironmentName": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the service environment.

", + "smithy.api#required": {} + } + }, + "serviceEnvironmentArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service environment.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.batch#DeleteComputeEnvironment": { "type": "operation", "input": { @@ -3303,6 +3456,54 @@ "smithy.api#output": {} } }, + "com.amazonaws.batch#DeleteServiceEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#DeleteServiceEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.batch#DeleteServiceEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Service environment. Before you can delete a service environment, you must first set its state to DISABLED with the UpdateServiceEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/deleteserviceenvironment", + "code": 200 + } + } + }, + "com.amazonaws.batch#DeleteServiceEnvironmentRequest": { + "type": "structure", + "members": { + "serviceEnvironment": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or ARN of the service environment to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.batch#DeleteServiceEnvironmentResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.batch#DeregisterJobDefinition": { "type": "operation", "input": { @@ -4014,82 +4215,334 @@ "smithy.api#output": {} } }, - "com.amazonaws.batch#Device": { + "com.amazonaws.batch#DescribeServiceEnvironments": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#DescribeServiceEnvironmentsRequest" + }, + "output": { + "target": "com.amazonaws.batch#DescribeServiceEnvironmentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes one or more of your service environments.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/describeserviceenvironments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "serviceEnvironments", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.batch#DescribeServiceEnvironmentsRequest": { "type": "structure", "members": { - "hostPath": { - "target": "com.amazonaws.batch#String", + "serviceEnvironments": { + "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The path for the device on the host container instance.

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

An array of service environment names or ARN entries.

" } }, - "containerPath": { - "target": "com.amazonaws.batch#String", + "maxResults": { + "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The path inside the container that's used to expose the host device. By default, the\n hostPath value is used.

" + "smithy.api#documentation": "

The maximum number of results returned by DescribeServiceEnvironments in paginated output. When this parameter is used, DescribeServiceEnvironments only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeServiceEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeServiceEnvironments returns up to 100 results and a nextToken value if applicable.

" } }, - "permissions": { - "target": "com.amazonaws.batch#DeviceCgroupPermissions", + "nextToken": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The explicit permissions to provide to the container for the device. By default, the\n container has permissions for read, write, and mknod for\n the device.

" + "smithy.api#documentation": "

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

\n \n

Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

An object that represents a container instance host device.

\n \n

This object isn't applicable to jobs that are running on Fargate resources and shouldn't\n be provided.

\n " + "smithy.api#input": {} } }, - "com.amazonaws.batch#DeviceCgroupPermission": { - "type": "enum", + "com.amazonaws.batch#DescribeServiceEnvironmentsResponse": { + "type": "structure", "members": { - "READ": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READ" - } - }, - "WRITE": { - "target": "smithy.api#Unit", + "serviceEnvironments": { + "target": "com.amazonaws.batch#ServiceEnvironmentDetailList", "traits": { - "smithy.api#enumValue": "WRITE" + "smithy.api#documentation": "

The list of service environments that match the request.

" } }, - "MKNOD": { - "target": "smithy.api#Unit", + "nextToken": { + "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#enumValue": "MKNOD" + "smithy.api#documentation": "

The nextToken value to include in a future DescribeServiceEnvironments request. When the results of a DescribeServiceEnvironments request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.batch#DeviceCgroupPermissions": { - "type": "list", - "member": { - "target": "com.amazonaws.batch#DeviceCgroupPermission" - } - }, - "com.amazonaws.batch#DevicesList": { - "type": "list", - "member": { - "target": "com.amazonaws.batch#Device" + "com.amazonaws.batch#DescribeServiceJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#DescribeServiceJobRequest" + }, + "output": { + "target": "com.amazonaws.batch#DescribeServiceJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

The details of a service job.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/describeservicejob", + "code": 200 + } } }, - "com.amazonaws.batch#EFSAuthorizationConfig": { + "com.amazonaws.batch#DescribeServiceJobRequest": { "type": "structure", "members": { - "accessPointId": { + "jobId": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon EFS access point ID to use. If an access point is specified, the root directory value\n specified in the EFSVolumeConfiguration must either be omitted or set to\n / which enforces the path set on the EFS access point. If an access point is used,\n transit encryption must be enabled in the EFSVolumeConfiguration. For more\n information, see Working\n with Amazon EFS access points in the Amazon Elastic File System User Guide.

" - } - }, - "iam": { - "target": "com.amazonaws.batch#EFSAuthorizationConfigIAM", - "traits": { - "smithy.api#documentation": "

Whether or not to use the Batch job IAM role defined in a job definition when mounting the\n Amazon EFS file system. If enabled, transit encryption must be enabled in the\n EFSVolumeConfiguration. If this parameter is omitted, the default value of\n DISABLED is used. For more information, see Using Amazon EFS access points in\n the Batch User Guide. EFS IAM authorization requires that\n TransitEncryption be ENABLED and that a JobRoleArn is\n specified.

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

The job ID for the service job to describe.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.batch#DescribeServiceJobResponse": { + "type": "structure", + "members": { + "attempts": { + "target": "com.amazonaws.batch#ServiceJobAttemptDetails", + "traits": { + "smithy.api#documentation": "

A list of job attempts associated with the service job.

" + } + }, + "createdAt": { + "target": "com.amazonaws.batch#Long", + "traits": { + "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the service job was created.

" + } + }, + "isTerminated": { + "target": "com.amazonaws.batch#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the service job has been terminated.

" + } + }, + "jobArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service job.

" + } + }, + "jobId": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The job ID for the service job.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the service job.

", + "smithy.api#required": {} + } + }, + "jobQueue": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the job queue that the service job is associated with.

", + "smithy.api#required": {} + } + }, + "latestAttempt": { + "target": "com.amazonaws.batch#LatestServiceJobAttempt", + "traits": { + "smithy.api#documentation": "

The latest attempt associated with the service job.

" + } + }, + "retryStrategy": { + "target": "com.amazonaws.batch#ServiceJobRetryStrategy", + "traits": { + "smithy.api#documentation": "

The retry strategy to use for failed service jobs that are submitted with this service job.

" + } + }, + "schedulingPriority": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The scheduling priority of the service job.

" + } + }, + "serviceRequestPayload": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The request, in JSON, for the service that the SubmitServiceJob operation is queueing.

" + } + }, + "serviceJobType": { + "target": "com.amazonaws.batch#ServiceJobType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of service job. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.

", + "smithy.api#required": {} + } + }, + "shareIdentifier": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The share identifier for the service job. This is used for fair-share scheduling.

" + } + }, + "startedAt": { + "target": "com.amazonaws.batch#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the service job was started.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.batch#ServiceJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of the service job.

", + "smithy.api#required": {} + } + }, + "statusReason": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

A short, human-readable string to provide more details for the current status of the service job.

" + } + }, + "stoppedAt": { + "target": "com.amazonaws.batch#Long", + "traits": { + "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the service job stopped running.

" + } + }, + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", + "traits": { + "smithy.api#documentation": "

The tags that are associated with the service job. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

" + } + }, + "timeoutConfig": { + "target": "com.amazonaws.batch#ServiceJobTimeout", + "traits": { + "smithy.api#documentation": "

The timeout configuration for the service job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.batch#Device": { + "type": "structure", + "members": { + "hostPath": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The path for the device on the host container instance.

", + "smithy.api#required": {} + } + }, + "containerPath": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The path inside the container that's used to expose the host device. By default, the\n hostPath value is used.

" + } + }, + "permissions": { + "target": "com.amazonaws.batch#DeviceCgroupPermissions", + "traits": { + "smithy.api#documentation": "

The explicit permissions to provide to the container for the device. By default, the\n container has permissions for read, write, and mknod for\n the device.

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

An object that represents a container instance host device.

\n \n

This object isn't applicable to jobs that are running on Fargate resources and shouldn't\n be provided.

\n " + } + }, + "com.amazonaws.batch#DeviceCgroupPermission": { + "type": "enum", + "members": { + "READ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READ" + } + }, + "WRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WRITE" + } + }, + "MKNOD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MKNOD" + } + } + } + }, + "com.amazonaws.batch#DeviceCgroupPermissions": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#DeviceCgroupPermission" + } + }, + "com.amazonaws.batch#DevicesList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#Device" + } + }, + "com.amazonaws.batch#EFSAuthorizationConfig": { + "type": "structure", + "members": { + "accessPointId": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon EFS access point ID to use. If an access point is specified, the root directory value\n specified in the EFSVolumeConfiguration must either be omitted or set to\n / which enforces the path set on the EFS access point. If an access point is used,\n transit encryption must be enabled in the EFSVolumeConfiguration. For more\n information, see Working\n with Amazon EFS access points in the Amazon Elastic File System User Guide.

" + } + }, + "iam": { + "target": "com.amazonaws.batch#EFSAuthorizationConfigIAM", + "traits": { + "smithy.api#documentation": "

Whether or not to use the Batch job IAM role defined in a job definition when mounting the\n Amazon EFS file system. If enabled, transit encryption must be enabled in the\n EFSVolumeConfiguration. If this parameter is omitted, the default value of\n DISABLED is used. For more information, see Using Amazon EFS access points in\n the Batch User Guide. EFS IAM authorization requires that\n TransitEncryption be ENABLED and that a JobRoleArn is\n specified.

" } } }, @@ -6079,6 +6532,18 @@ "smithy.api#required": {} } }, + "serviceEnvironmentOrder": { + "target": "com.amazonaws.batch#ServiceEnvironmentOrders", + "traits": { + "smithy.api#documentation": "

The order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.

" + } + }, + "jobQueueType": { + "target": "com.amazonaws.batch#JobQueueType", + "traits": { + "smithy.api#documentation": "

The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS, or ECS_FARGATE depending on the compute environment.

" + } + }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { @@ -6102,6 +6567,35 @@ "target": "com.amazonaws.batch#JobQueueDetail" } }, + "com.amazonaws.batch#JobQueueType": { + "type": "enum", + "members": { + "EKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS" + } + }, + "ECS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS" + } + }, + "ECS_FARGATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS_FARGATE" + } + }, + "SAGEMAKER_TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAGEMAKER_TRAINING" + } + } + } + }, "com.amazonaws.batch#JobStateTimeLimitAction": { "type": "structure", "members": { @@ -6156,6 +6650,12 @@ "traits": { "smithy.api#enumValue": "CANCEL" } + }, + "TERMINATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATE" + } } } }, @@ -6370,6 +6870,20 @@ } } }, + "com.amazonaws.batch#LatestServiceJobAttempt": { + "type": "structure", + "members": { + "serviceResourceId": { + "target": "com.amazonaws.batch#ServiceResourceId", + "traits": { + "smithy.api#documentation": "

The service resource identifier associated with the service job attempt.

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

Information about the latest attempt of a service job. A Service job can transition from SCHEDULED back to RUNNABLE state when they encounter capacity constraints.

" + } + }, "com.amazonaws.batch#LaunchTemplateSpecification": { "type": "structure", "members": { @@ -7074,13 +7588,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.batch#ListTagsForResource": { + "com.amazonaws.batch#ListServiceJobs": { "type": "operation", "input": { - "target": "com.amazonaws.batch#ListTagsForResourceRequest" + "target": "com.amazonaws.batch#ListServiceJobsRequest" }, "output": { - "target": "com.amazonaws.batch#ListTagsForResourceResponse" + "target": "com.amazonaws.batch#ListServiceJobsResponse" }, "errors": [ { @@ -7091,30 +7605,121 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

", - "smithy.api#examples": [ - { - "title": "ListTagsForResource Example", - "documentation": "This demonstrates calling the ListTagsForResource action.", - "input": { - "resourceArn": "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1" - }, - "output": { - "tags": { - "Stage": "Alpha", - "Department": "Engineering", - "User": "JaneDoe" - } - } - } - ], + "smithy.api#documentation": "

Returns a list of service jobs for a specified job queue.

", "smithy.api#http": { - "method": "GET", - "uri": "/v1/tags/{resourceArn}", + "method": "POST", + "uri": "/v1/listservicejobs", "code": 200 - } - } - }, + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "jobSummaryList", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.batch#ListServiceJobsRequest": { + "type": "structure", + "members": { + "jobQueue": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The name or ARN of the job queue with which to list service jobs.

" + } + }, + "jobStatus": { + "target": "com.amazonaws.batch#ServiceJobStatus", + "traits": { + "smithy.api#documentation": "

The job status with which to filter service jobs.

" + } + }, + "maxResults": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results returned by ListServiceJobs in paginated output. When this parameter is used, ListServiceJobs only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListServiceJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServiceJobs returns up to 100 results and a nextToken value if applicable.

" + } + }, + "nextToken": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

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

\n \n

Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + }, + "filters": { + "target": "com.amazonaws.batch#ListJobsFilterList", + "traits": { + "smithy.api#documentation": "

The filters to apply to the service job list query. The filter names and values can be:

\n
    \n
  • \n

    name: JOB_STATUS\n

    \n

    values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED | SCHEDULED\n

    \n
    • \n
  • \n

    name: JOB_NAME\n

    \n

    values: case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the '*'.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.batch#ListServiceJobsResponse": { + "type": "structure", + "members": { + "jobSummaryList": { + "target": "com.amazonaws.batch#ServiceJobSummaryList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of service job summaries.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future ListServiceJobs request. When the results of a ListServiceJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.batch#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.batch#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

", + "smithy.api#examples": [ + { + "title": "ListTagsForResource Example", + "documentation": "This demonstrates calling the ListTagsForResource action.", + "input": { + "resourceArn": "arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1" + }, + "output": { + "tags": { + "Stage": "Alpha", + "Department": "Engineering", + "User": "JaneDoe" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/v1/tags/{resourceArn}", + "code": 200 + } + } + }, "com.amazonaws.batch#ListTagsForResourceRequest": { "type": "structure", "members": { @@ -7995,63 +8600,528 @@ "arn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the scheduling policy.

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

Amazon Resource Name (ARN) of the scheduling policy.

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

An object that contains the details of a scheduling policy that's returned in a\n ListSchedulingPolicy action.

" + } + }, + "com.amazonaws.batch#SchedulingPolicyListingDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#SchedulingPolicyListingDetail" + } + }, + "com.amazonaws.batch#Secret": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the secret.

", + "smithy.api#required": {} + } + }, + "valueFrom": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of\n the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

\n \n

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're\n launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter\n exists in a different Region, then the full ARN must be specified.

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

An object that represents the secret to expose to your container. Secrets can be exposed to\n a container in the following ways:

\n
    \n
  • \n

    To inject sensitive data into your containers as environment variables, use the\n secrets container definition parameter.

    \n
    • \n
  • \n

    To reference sensitive information in the log configuration of a container, use the\n secretOptions container definition parameter.

    \n
    • \n
\n

For more information, see Specifying sensitive data in the\n Batch User Guide.

" + } + }, + "com.amazonaws.batch#SecretList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#Secret" + } + }, + "com.amazonaws.batch#ServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.batch#String" + } + }, + "traits": { + "smithy.api#documentation": "

These errors are usually caused by a server issue.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.batch#ServiceEnvironmentDetail": { + "type": "structure", + "members": { + "serviceEnvironmentName": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the service environment.

", + "smithy.api#required": {} + } + }, + "serviceEnvironmentArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service environment.

", + "smithy.api#required": {} + } + }, + "serviceEnvironmentType": { + "target": "com.amazonaws.batch#ServiceEnvironmentType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of service environment. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.batch#ServiceEnvironmentState", + "traits": { + "smithy.api#documentation": "

The state of the service environment. Valid values are ENABLED and DISABLED.

" + } + }, + "status": { + "target": "com.amazonaws.batch#ServiceEnvironmentStatus", + "traits": { + "smithy.api#documentation": "

The current status of the service environment.

" + } + }, + "capacityLimits": { + "target": "com.amazonaws.batch#CapacityLimits", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", + "traits": { + "smithy.api#documentation": "

The tags associated with the service environment. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

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

Detailed information about a service environment, including its configuration, state, and capacity limits.

" + } + }, + "com.amazonaws.batch#ServiceEnvironmentDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#ServiceEnvironmentDetail" + } + }, + "com.amazonaws.batch#ServiceEnvironmentOrder": { + "type": "structure", + "members": { + "order": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The order of the service environment. Job queues with a higher priority are evaluated first when associated with the same service environment.

", + "smithy.api#required": {} + } + }, + "serviceEnvironment": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or ARN of the service environment.

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

Specifies the order of a service environment for a job queue. This determines the priority order when multiple service environments are associated with the same job queue.

" + } + }, + "com.amazonaws.batch#ServiceEnvironmentOrders": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#ServiceEnvironmentOrder" + } + }, + "com.amazonaws.batch#ServiceEnvironmentState": { + "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.batch#ServiceEnvironmentStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "VALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALID" + } + }, + "INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID" + } + } + } + }, + "com.amazonaws.batch#ServiceEnvironmentType": { + "type": "enum", + "members": { + "SAGEMAKER_TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAGEMAKER_TRAINING" + } + } + } + }, + "com.amazonaws.batch#ServiceJobAttemptDetail": { + "type": "structure", + "members": { + "serviceResourceId": { + "target": "com.amazonaws.batch#ServiceResourceId", + "traits": { + "smithy.api#documentation": "

The service resource identifier associated with the service job attempt.

" + } + }, + "startedAt": { + "target": "com.amazonaws.batch#Long", + "traits": { + "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the service job attempt was started.

" + } + }, + "stoppedAt": { + "target": "com.amazonaws.batch#Long", + "traits": { + "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the service job attempt stopped running.

" + } + }, + "statusReason": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

A string that provides additional details for the current status of the service job attempt.

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

Detailed information about an attempt to run a service job.

" + } + }, + "com.amazonaws.batch#ServiceJobAttemptDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#ServiceJobAttemptDetail" + } + }, + "com.amazonaws.batch#ServiceJobEvaluateOnExit": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.batch#ServiceJobRetryAction", + "traits": { + "smithy.api#documentation": "

The action to take if the service job exits with the specified condition. Valid values are RETRY and EXIT.

" + } + }, + "onStatusReason": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

Contains a glob pattern to match against the StatusReason returned for a job. The pattern can contain up to 512 characters and can contain all printable characters. It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

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

Specifies conditions for when to exit or retry a service job based on the exit status or status reason.

" + } + }, + "com.amazonaws.batch#ServiceJobEvaluateOnExitList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#ServiceJobEvaluateOnExit" + } + }, + "com.amazonaws.batch#ServiceJobRetryAction": { + "type": "enum", + "members": { + "RETRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRY" + } + }, + "EXIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXIT" + } + } + } + }, + "com.amazonaws.batch#ServiceJobRetryStrategy": { + "type": "structure", + "members": { + "attempts": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of times to move a service job to RUNNABLE status. You can specify between 1 and 10 attempts.

", + "smithy.api#required": {} + } + }, + "evaluateOnExit": { + "target": "com.amazonaws.batch#ServiceJobEvaluateOnExitList", + "traits": { + "smithy.api#documentation": "

Array of ServiceJobEvaluateOnExit objects that specify conditions under which the service job should be retried or failed.

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

The retry strategy for service jobs. This defines how many times to retry a failed service job and under what conditions. For more information, see Service job retry strategies in the Batch User Guide.

" + } + }, + "com.amazonaws.batch#ServiceJobStatus": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBMITTED" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "RUNNABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNABLE" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.batch#ServiceJobSummary": { + "type": "structure", + "members": { + "latestAttempt": { + "target": "com.amazonaws.batch#LatestServiceJobAttempt", + "traits": { + "smithy.api#documentation": "

Information about the latest attempt for the service job.

" + } + }, + "createdAt": { + "target": "com.amazonaws.batch#Long", + "traits": { + "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the service job was created.

" + } + }, + "jobArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service job.

" + } + }, + "jobId": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The job ID for the service job.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the service job.

", + "smithy.api#required": {} + } + }, + "serviceJobType": { + "target": "com.amazonaws.batch#ServiceJobType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of service job. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING.

", + "smithy.api#required": {} + } + }, + "shareIdentifier": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The share identifier for the job.

" + } + }, + "status": { + "target": "com.amazonaws.batch#ServiceJobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the service job.

" + } + }, + "statusReason": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

A short string to provide more details on the current status of the service job.

" + } + }, + "startedAt": { + "target": "com.amazonaws.batch#Long", + "traits": { + "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the service job was started.

" + } + }, + "stoppedAt": { + "target": "com.amazonaws.batch#Long", + "traits": { + "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the service job stopped running.

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

Summary information about a service job.

" + } + }, + "com.amazonaws.batch#ServiceJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#ServiceJobSummary" + } + }, + "com.amazonaws.batch#ServiceJobTimeout": { + "type": "structure", + "members": { + "attemptDurationSeconds": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The maximum duration in seconds that a service job attempt can run. After this time is reached, Batch terminates the service job attempt.

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

An object that contains the details of a scheduling policy that's returned in a\n ListSchedulingPolicy action.

" + "smithy.api#documentation": "

The timeout configuration for service jobs.

" } }, - "com.amazonaws.batch#SchedulingPolicyListingDetailList": { - "type": "list", - "member": { - "target": "com.amazonaws.batch#SchedulingPolicyListingDetail" + "com.amazonaws.batch#ServiceJobType": { + "type": "enum", + "members": { + "SAGEMAKER_TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAGEMAKER_TRAINING" + } + } } }, - "com.amazonaws.batch#Secret": { + "com.amazonaws.batch#ServiceResourceId": { "type": "structure", "members": { "name": { - "target": "com.amazonaws.batch#String", + "target": "com.amazonaws.batch#ServiceResourceIdName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the secret.

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

The name of the resource identifier.

", "smithy.api#required": {} } }, - "valueFrom": { + "value": { "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of\n the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

\n \n

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're\n launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter\n exists in a different Region, then the full ARN must be specified.

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

The value of the resource identifier.

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

An object that represents the secret to expose to your container. Secrets can be exposed to\n a container in the following ways:

\n
    \n
  • \n

    To inject sensitive data into your containers as environment variables, use the\n secrets container definition parameter.

    \n
    • \n
  • \n

    To reference sensitive information in the log configuration of a container, use the\n secretOptions container definition parameter.

    \n
    • \n
\n

For more information, see Specifying sensitive data in the\n Batch User Guide.

" - } - }, - "com.amazonaws.batch#SecretList": { - "type": "list", - "member": { - "target": "com.amazonaws.batch#Secret" + "smithy.api#documentation": "

The Batch unique identifier.

" } }, - "com.amazonaws.batch#ServerException": { - "type": "structure", + "com.amazonaws.batch#ServiceResourceIdName": { + "type": "enum", "members": { - "message": { - "target": "com.amazonaws.batch#String" + "SAGEMAKER_TRAINING_JOB_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TrainingJobArn" + } } - }, - "traits": { - "smithy.api#documentation": "

These errors are usually caused by a server issue.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 } }, "com.amazonaws.batch#ShareAttributes": { @@ -8278,6 +9348,138 @@ "smithy.api#output": {} } }, + "com.amazonaws.batch#SubmitServiceJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#SubmitServiceJobRequest" + }, + "output": { + "target": "com.amazonaws.batch#SubmitServiceJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Submits a service job to a specified job queue to run on SageMaker AI. A service job is a unit of work that you submit to Batch for execution on SageMaker AI.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/submitservicejob", + "code": 200 + } + } + }, + "com.amazonaws.batch#SubmitServiceJobRequest": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", + "smithy.api#required": {} + } + }, + "jobQueue": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type SAGEMAKER_TRAINING.

", + "smithy.api#required": {} + } + }, + "retryStrategy": { + "target": "com.amazonaws.batch#ServiceJobRetryStrategy", + "traits": { + "smithy.api#documentation": "

The retry strategy to use for failed service jobs that are submitted with this service job request.

" + } + }, + "schedulingPriority": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The scheduling priority of the service job. Valid values are integers between 0 and 9999.

" + } + }, + "serviceRequestPayload": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The request, in JSON, for the service that the SubmitServiceJob operation is queueing.

", + "smithy.api#required": {} + } + }, + "serviceJobType": { + "target": "com.amazonaws.batch#ServiceJobType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING.

", + "smithy.api#required": {} + } + }, + "shareIdentifier": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair-\n share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter\n must be specified.

" + } + }, + "timeoutConfig": { + "target": "com.amazonaws.batch#ServiceJobTimeout", + "traits": { + "smithy.api#documentation": "

The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.

" + } + }, + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", + "traits": { + "smithy.api#documentation": "

The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.

" + } + }, + "clientToken": { + "target": "com.amazonaws.batch#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and clientTokens are received, these requests are considered the same request and the second request is rejected.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.batch#SubmitServiceJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the service job.

" + } + }, + "jobName": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the service job.

", + "smithy.api#required": {} + } + }, + "jobId": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier for the service job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.batch#TagKey": { "type": "string", "traits": { @@ -8788,6 +9990,62 @@ "smithy.api#output": {} } }, + "com.amazonaws.batch#TerminateServiceJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#TerminateServiceJobRequest" + }, + "output": { + "target": "com.amazonaws.batch#TerminateServiceJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Terminates a service job in a job queue.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/terminateservicejob", + "code": 200 + } + } + }, + "com.amazonaws.batch#TerminateServiceJobRequest": { + "type": "structure", + "members": { + "jobId": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The service job ID of the service job to terminate.

", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A message to attach to the service job that explains the reason for canceling it. This message is returned by DescribeServiceJob operations on the service job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.batch#TerminateServiceJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.batch#Tmpfs": { "type": "structure", "members": { @@ -9225,6 +10483,12 @@ "smithy.api#documentation": "

Details the set of compute environments mapped to a job queue and their order relative to\n each other. This is one of the parameters used by the job scheduler to determine which compute\n environment runs a given job. Compute environments must be in the VALID state\n before you can associate them with a job queue. All of the compute environments must be either\n EC2 (EC2 or SPOT) or Fargate (FARGATE or\n FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same\n architecture. Batch doesn't support mixing compute environment architecture types in a\n single job queue.

\n " } }, + "serviceEnvironmentOrder": { + "target": "com.amazonaws.batch#ServiceEnvironmentOrders", + "traits": { + "smithy.api#documentation": "

The order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.

" + } + }, "jobStateTimeLimitActions": { "target": "com.amazonaws.batch#JobStateTimeLimitActions", "traits": { @@ -9332,6 +10596,83 @@ "smithy.api#output": {} } }, + "com.amazonaws.batch#UpdateServiceEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#UpdateServiceEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.batch#UpdateServiceEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a service environment. You can update the state of a service environment from ENABLED to DISABLED to prevent new service jobs from being placed in the service environment.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/updateserviceenvironment", + "code": 200 + } + } + }, + "com.amazonaws.batch#UpdateServiceEnvironmentRequest": { + "type": "structure", + "members": { + "serviceEnvironment": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or ARN of the service environment to update.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.batch#ServiceEnvironmentState", + "traits": { + "smithy.api#documentation": "

The state of the service environment.

" + } + }, + "capacityLimits": { + "target": "com.amazonaws.batch#CapacityLimits", + "traits": { + "smithy.api#documentation": "

The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.batch#UpdateServiceEnvironmentResponse": { + "type": "structure", + "members": { + "serviceEnvironmentName": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the service environment that was updated.

", + "smithy.api#required": {} + } + }, + "serviceEnvironmentArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service environment that was updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.batch#UserdataType": { "type": "enum", "members": { diff --git a/codegen/sdk/aws-models/bedrock-agentcore.json b/codegen/sdk/aws-models/bedrock-agentcore.json index c41fb815b0f..a20b51180e2 100644 --- a/codegen/sdk/aws-models/bedrock-agentcore.json +++ b/codegen/sdk/aws-models/bedrock-agentcore.json @@ -46,7 +46,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains summary information about an actor in a memory store.

" + "smithy.api#documentation": "

Contains summary information about an actor in an AgentCore Memory resource.

" } }, "com.amazonaws.bedrockagentcore#ActorSummaryList": { @@ -117,7 +117,7 @@ "http/1.1" ] }, - "smithy.api#documentation": "

Amazon Bedrock AgentCore is in preview release and is subject to change.

Data plane operations for Amazon Bedrock AgentCore.

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

Amazon Bedrock AgentCore is in preview release and is subject to change.

Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.

", "smithy.api#title": "Amazon Bedrock AgentCore Data Plane Fronting Layer", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -875,7 +875,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about a branch in a memory store. Branches allow for organizing events into different conversation threads or paths.

" + "smithy.api#documentation": "

Contains information about a branch in an AgentCore Memory resource. Branches allow for organizing events into different conversation threads or paths.

" } }, "com.amazonaws.bedrockagentcore#BranchFilter": { @@ -1412,7 +1412,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an event in a memory store. Events represent interactions or activities that occur within a session and are associated with specific actors.

To use this operation, you must have the genesismemory:CreateEvent permission.

This operation is subject to request rate limiting.

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

Creates an event in an AgentCore Memory resource. Events represent interactions or activities that occur within a session and are associated with specific actors.

To use this operation, you must have the bedrock-agentcore:CreateEvent permission.

This operation is subject to request rate limiting.

", "smithy.api#http": { "method": "POST", "uri": "/memories/{memoryId}/events" @@ -1426,7 +1426,7 @@ "memoryId": { "target": "com.amazonaws.bedrockagentcore#MemoryId", "traits": { - "smithy.api#documentation": "

The identifier of the memory store in which to create the event.

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

The identifier of the AgentCore Memory resource in which to create the event.

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

Deletes an event from a memory store. When you delete an event, it is permanently removed.

To use this operation, you must have the genesismemory:DeleteEvent permission.

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

Deletes an event from an AgentCore Memory resource. When you delete an event, it is permanently removed.

To use this operation, you must have the bedrock-agentcore:DeleteEvent permission.

", "smithy.api#http": { "method": "DELETE", "uri": "/memories/{memoryId}/actor/{actorId}/sessions/{sessionId}/events/{eventId}" @@ -1581,7 +1581,7 @@ "memoryId": { "target": "com.amazonaws.bedrockagentcore#MemoryId", "traits": { - "smithy.api#documentation": "

The identifier of the memory store from which to delete the event.

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

The identifier of the AgentCore Memory resource from which to delete the event.

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

Deletes a memory record from a memory store. When you delete a memory record, it is permanently removed.

To use this operation, you must have the genesismemory:DeleteMemoryRecord permission.

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

Deletes a memory record from an AgentCore Memory resource. When you delete a memory record, it is permanently removed.

To use this operation, you must have the bedrock-agentcore:DeleteMemoryRecord permission.

", "smithy.api#http": { "method": "DELETE", "uri": "/memories/{memoryId}/memoryRecords/{memoryRecordId}" @@ -1675,7 +1675,7 @@ "memoryId": { "target": "com.amazonaws.bedrockagentcore#MemoryId", "traits": { - "smithy.api#documentation": "

The identifier of the memory store from which to delete the memory record.

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

The identifier of the AgentCore Memory resource from which to delete the memory record.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1717,7 +1717,7 @@ "memoryId": { "target": "com.amazonaws.bedrockagentcore#MemoryId", "traits": { - "smithy.api#documentation": "

The identifier of the memory store containing the event.

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

The identifier of the AgentCore Memory resource containing the event.

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

Contains information about an event in a memory store.

" + "smithy.api#documentation": "

Contains information about an event in an AgentCore Memory resource.

" } }, "com.amazonaws.bedrockagentcore#EventId": { @@ -2058,7 +2058,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a specific event in a memory store.

To use this operation, you must have the genesismemory:GetEvent permission.

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

Retrieves information about a specific event in an AgentCore Memory resource.

To use this operation, you must have the bedrock-agentcore:GetEvent permission.

", "smithy.api#http": { "method": "GET", "uri": "/memories/{memoryId}/actor/{actorId}/sessions/{sessionId}/events/{eventId}" @@ -2072,7 +2072,7 @@ "memoryId": { "target": "com.amazonaws.bedrockagentcore#MemoryId", "traits": { - "smithy.api#documentation": "

The identifier of the memory store containing the event.

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

The identifier of the AgentCore Memory resource containing the event.

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

Retrieves a specific memory record from a memory store.

To use this operation, you must have the genesismemory:GetMemoryRecord permission.

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

Retrieves a specific memory record from an AgentCore Memory resource.

To use this operation, you must have the bedrock-agentcore:GetMemoryRecord permission.

", "smithy.api#http": { "method": "GET", "uri": "/memories/{memoryId}/memoryRecord/{memoryRecordId}" @@ -2167,7 +2167,7 @@ "memoryId": { "target": "com.amazonaws.bedrockagentcore#MemoryId", "traits": { - "smithy.api#documentation": "

The identifier of the memory store containing the memory record.

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

The identifier of the AgentCore Memory resource containing the memory record.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2305,7 +2305,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Reaturns the Oauth2Token of the provided resource

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

Returns the OAuth 2.0 token of the provided resource

", "smithy.api#http": { "uri": "/identities/oauth2/token", "method": "POST" @@ -2323,12 +2323,6 @@ "smithy.api#required": {} } }, - "userId": { - "target": "com.amazonaws.bedrockagentcore#UserIdType", - "traits": { - "smithy.api#documentation": "

The user ID of the user you're retrieving the token on behalf of.

" - } - }, "resourceCredentialProviderName": { "target": "com.amazonaws.bedrockagentcore#CredentialProviderName", "traits": { @@ -2705,7 +2699,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends a request to an agent runtime in Amazon Bedrock and receives responses in real-time. The agent processes the request using the configured foundation model and any associated knowledge bases or action groups.

To invoke an agent runtime, you must specify the agent runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or alias of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

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

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent you must specify the AgentCore Runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission.

", "smithy.api#http": { "method": "POST", "uri": "/runtimes/{agentRuntimeArn}/invocations", @@ -2814,7 +2808,7 @@ "qualifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The qualifier to use for the agent runtime. This can be a version number or an alias name that points to a specific version. If not specified, Amazon Bedrock uses the default version of the agent runtime.

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

The qualifier to use for the agent runtime. This can be a version number or an endpoint name that points to a specific version. If not specified, Amazon Bedrock uses the default version of the agent runtime.

", "smithy.api#httpQuery": "qualifier" } }, @@ -3042,7 +3036,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all actors in a memory store. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the genesismemory:ListActors permission.

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

Lists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListActors permission.

", "smithy.api#http": { "method": "POST", "uri": "/memories/{memoryId}/actors" @@ -3062,7 +3056,7 @@ "memoryId": { "target": "com.amazonaws.bedrockagentcore#MemoryId", "traits": { - "smithy.api#documentation": "

The identifier of the memory store for which to list actors.

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

The identifier of the AgentCore Memory resource for which to list actors.

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

Lists events in a memory store based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the genesismemory:ListEvents permission.

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

Lists events in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListEvents permission.

", "smithy.api#http": { "method": "POST", "uri": "/memories/{memoryId}/actor/{actorId}/sessions/{sessionId}" @@ -3338,7 +3332,7 @@ "memoryId": { "target": "com.amazonaws.bedrockagentcore#MemoryId", "traits": { - "smithy.api#documentation": "

The identifier of the memory store for which to list events.

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

The identifier of the AgentCore Memory resource for which to list events.

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

Lists memory records in a memory store based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the genesismemory:ListMemoryRecords permission.

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

Lists memory records in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListMemoryRecords permission.

", "smithy.api#http": { "method": "POST", "uri": "/memories/{memoryId}/memoryRecords" @@ -3463,7 +3457,7 @@ "memoryId": { "target": "com.amazonaws.bedrockagentcore#MemoryId", "traits": { - "smithy.api#documentation": "

The identifier of the memory store for which to list memory records.

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

The identifier of the AgentCore Memory resource for which to list memory records.

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

Lists sessions in a memory store based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the genesismemory:ListSessions permission.

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

Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListSessions permission.

", "smithy.api#http": { "method": "POST", "uri": "/memories/{memoryId}/actor/{actorId}/sessions" @@ -3572,7 +3566,7 @@ "memoryId": { "target": "com.amazonaws.bedrockagentcore#MemoryId", "traits": { - "smithy.api#documentation": "

The identifier of the memory store for which to list sessions.

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

The identifier of the AgentCore Memory resource for which to list sessions.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3718,7 +3712,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about a memory record in a memory store.

" + "smithy.api#documentation": "

Contains information about a memory record in an AgentCore Memory resource.

" } }, "com.amazonaws.bedrockagentcore#MemoryRecordId": { @@ -4078,7 +4072,7 @@ } ], "traits": { - "smithy.api#documentation": "

Searches for and retrieves memory records from a memory store based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the genesismemory:RetrieveMemoryRecords permission.

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

Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:RetrieveMemoryRecords permission.

", "smithy.api#http": { "method": "POST", "uri": "/memories/{memoryId}/retrieve" @@ -4097,7 +4091,7 @@ "memoryId": { "target": "com.amazonaws.bedrockagentcore#MemoryId", "traits": { - "smithy.api#documentation": "

The identifier of the memory store from which to retrieve memory records.

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

The identifier of the AgentCore Memory resource from which to retrieve memory records.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4319,7 +4313,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains summary information about a session in a memory store.

" + "smithy.api#documentation": "

Contains summary information about a session in an AgentCore Memory resource.

" } }, "com.amazonaws.bedrockagentcore#SessionSummaryList": { diff --git a/codegen/sdk/aws-models/bedrock-runtime.json b/codegen/sdk/aws-models/bedrock-runtime.json index 656e1655c5e..82b48461a18 100644 --- a/codegen/sdk/aws-models/bedrock-runtime.json +++ b/codegen/sdk/aws-models/bedrock-runtime.json @@ -1075,6 +1075,15 @@ "smithy.api#documentation": "

The Model automatically decides if a tool should be called or whether to generate text instead. For example, {\"auto\" : {}}.

" } }, + "com.amazonaws.bedrockruntime#AutomatedReasoningRuleIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 12 + }, + "smithy.api#pattern": "^[a-z0-9]{12}$" + } + }, "com.amazonaws.bedrockruntime#BidirectionalInputPayloadPart": { "type": "structure", "members": { @@ -2480,6 +2489,12 @@ "smithy.api#documentation": "

The contextual grounding policy used for the guardrail assessment.

" } }, + "automatedReasoningPolicy": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningPolicyAssessment", + "traits": { + "smithy.api#documentation": "

The automated reasoning policy assessment results, including logical validation findings for the input content.

" + } + }, "invocationMetrics": { "target": "com.amazonaws.bedrockruntime#GuardrailInvocationMetrics", "traits": { @@ -2515,6 +2530,456 @@ "target": "com.amazonaws.bedrockruntime#GuardrailAssessment" } }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningDifferenceScenarioList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningScenario" + }, + "traits": { + "smithy.api#length": { + "max": 2 + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningFinding": { + "type": "union", + "members": { + "valid": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningValidFinding" + }, + "invalid": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningInvalidFinding" + }, + "satisfiable": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningSatisfiableFinding" + }, + "impossible": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningImpossibleFinding" + }, + "translationAmbiguous": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslationAmbiguousFinding" + }, + "tooComplex": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTooComplexFinding" + }, + "noTranslations": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningNoTranslationsFinding" + } + }, + "traits": { + "smithy.api#documentation": "

Represents a logical validation result from automated reasoning policy evaluation. The finding indicates whether claims in the input are logically valid, invalid, satisfiable, impossible, or have other logical issues.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningFindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningFinding" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningImpossibleFinding": { + "type": "structure", + "members": { + "translation": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslation", + "traits": { + "smithy.api#documentation": "

The logical translation of the input that this finding evaluates.

" + } + }, + "contradictingRules": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningRuleList", + "traits": { + "smithy.api#documentation": "

The automated reasoning policy rules that contradict the claims and/or premises in the input.

" + } + }, + "logicWarning": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningLogicWarning", + "traits": { + "smithy.api#documentation": "

Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.

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

Indicates that no valid claims can be made due to logical contradictions in the premises or rules.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningInputTextReference": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningStatementNaturalLanguageContent", + "traits": { + "smithy.api#documentation": "

The specific text from the original input that this reference points to.

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

References a portion of the original input text that corresponds to logical elements.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningInputTextReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningInputTextReference" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningInvalidFinding": { + "type": "structure", + "members": { + "translation": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslation", + "traits": { + "smithy.api#documentation": "

The logical translation of the input that this finding invalidates.

" + } + }, + "contradictingRules": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningRuleList", + "traits": { + "smithy.api#documentation": "

The automated reasoning policy rules that contradict the claims in the input.

" + } + }, + "logicWarning": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningLogicWarning", + "traits": { + "smithy.api#documentation": "

Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.

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

Indicates that the claims are logically false and contradictory to the established rules or premises.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningLogicWarning": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningLogicWarningType", + "traits": { + "smithy.api#documentation": "

The category of the detected logical issue, such as statements that are always true or always false.

" + } + }, + "premises": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningStatementList", + "traits": { + "smithy.api#documentation": "

The logical statements that serve as premises under which the claims are validated.

" + } + }, + "claims": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningStatementList", + "traits": { + "smithy.api#documentation": "

The logical statements that are validated while assuming the policy and premises.

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

Identifies logical issues in the translated statements that exist independent of any policy rules, such as statements that are always true or always false.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningLogicWarningType": { + "type": "enum", + "members": { + "ALWAYS_FALSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALWAYS_FALSE" + } + }, + "ALWAYS_TRUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALWAYS_TRUE" + } + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningNoTranslationsFinding": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Indicates that no relevant logical information could be extracted from the input for validation.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningPoliciesProcessed": { + "type": "integer" + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningPolicyAssessment": { + "type": "structure", + "members": { + "findings": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningFindingList", + "traits": { + "smithy.api#documentation": "

List of logical validation results produced by evaluating the input content against automated reasoning policies.

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

Contains the results of automated reasoning policy evaluation, including logical findings about the validity of claims made in the input content.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningPolicyUnitsProcessed": { + "type": "integer" + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningPolicyVersionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?$" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningRule": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.bedrockruntime#AutomatedReasoningRuleIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the automated reasoning rule.

" + } + }, + "policyVersionArn": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningPolicyVersionArn", + "traits": { + "smithy.api#documentation": "

The ARN of the automated reasoning policy version that contains this rule.

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

References a specific automated reasoning policy rule that was applied during evaluation.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningRule" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningSatisfiableFinding": { + "type": "structure", + "members": { + "translation": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslation", + "traits": { + "smithy.api#documentation": "

The logical translation of the input that this finding evaluates.

" + } + }, + "claimsTrueScenario": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningScenario", + "traits": { + "smithy.api#documentation": "

An example scenario demonstrating how the claims could be logically true.

" + } + }, + "claimsFalseScenario": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningScenario", + "traits": { + "smithy.api#documentation": "

An example scenario demonstrating how the claims could be logically false.

" + } + }, + "logicWarning": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningLogicWarning", + "traits": { + "smithy.api#documentation": "

Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.

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

Indicates that the claims could be either true or false depending on additional assumptions not provided in the input.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningScenario": { + "type": "structure", + "members": { + "statements": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningStatementList", + "traits": { + "smithy.api#documentation": "

List of logical assignments and statements that define this scenario.

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

Represents a logical scenario where claims can be evaluated as true or false, containing specific logical assignments.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningStatement": { + "type": "structure", + "members": { + "logic": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningStatementLogicContent", + "traits": { + "smithy.api#documentation": "

The formal logical representation of the statement.

" + } + }, + "naturalLanguage": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningStatementNaturalLanguageContent", + "traits": { + "smithy.api#documentation": "

The natural language explanation of the logical statement.

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

A logical statement that includes both formal logic representation and natural language explanation.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningStatementList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningStatement" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningStatementLogicContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningStatementNaturalLanguageContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTooComplexFinding": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Indicates that the input exceeds the processing capacity due to the volume or complexity of the logical information.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslation": { + "type": "structure", + "members": { + "premises": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningStatementList", + "traits": { + "smithy.api#documentation": "

The logical statements that serve as the foundation or assumptions for the claims.

" + } + }, + "claims": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningStatementList", + "traits": { + "smithy.api#documentation": "

The logical statements that are being validated against the premises and policy rules.

" + } + }, + "untranslatedPremises": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningInputTextReferenceList", + "traits": { + "smithy.api#documentation": "

References to portions of the original input text that correspond to the premises but could not be fully translated.

" + } + }, + "untranslatedClaims": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningInputTextReferenceList", + "traits": { + "smithy.api#documentation": "

References to portions of the original input text that correspond to the claims but could not be fully translated.

" + } + }, + "confidence": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslationConfidence", + "traits": { + "smithy.api#documentation": "

A confidence score between 0 and 1 indicating how certain the system is about the logical translation.

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

Contains the logical translation of natural language input into formal logical statements, including premises, claims, and confidence scores.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslationAmbiguousFinding": { + "type": "structure", + "members": { + "options": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslationOptionList", + "traits": { + "smithy.api#documentation": "

Different logical interpretations that were detected during translation of the input.

" + } + }, + "differenceScenarios": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningDifferenceScenarioList", + "traits": { + "smithy.api#documentation": "

Scenarios showing how the different translation options differ in meaning.

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

Indicates that the input has multiple valid logical interpretations, requiring additional context or clarification.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslationConfidence": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslationList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslation" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslationOption": { + "type": "structure", + "members": { + "translations": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslationList", + "traits": { + "smithy.api#documentation": "

Example translations that provide this possible interpretation of the input.

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

Represents one possible logical interpretation of ambiguous input content.

" + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslationOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslationOption" + }, + "traits": { + "smithy.api#length": { + "max": 2 + } + } + }, + "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningValidFinding": { + "type": "structure", + "members": { + "translation": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningTranslation", + "traits": { + "smithy.api#documentation": "

The logical translation of the input that this finding validates.

" + } + }, + "claimsTrueScenario": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningScenario", + "traits": { + "smithy.api#documentation": "

An example scenario demonstrating how the claims are logically true.

" + } + }, + "supportingRules": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningRuleList", + "traits": { + "smithy.api#documentation": "

The automated reasoning policy rules that support why this result is considered valid.

" + } + }, + "logicWarning": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningLogicWarning", + "traits": { + "smithy.api#documentation": "

Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.

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

Indicates that the claims are definitively true and logically implied by the premises, with no possible alternative interpretations.

" + } + }, "com.amazonaws.bedrockruntime#GuardrailConfiguration": { "type": "structure", "members": { @@ -3919,6 +4384,18 @@ "traits": { "smithy.api#documentation": "

The content policy image units processed by the guardrail.

" } + }, + "automatedReasoningPolicyUnits": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningPolicyUnitsProcessed", + "traits": { + "smithy.api#documentation": "

The number of text units processed by the automated reasoning policy.

" + } + }, + "automatedReasoningPolicies": { + "target": "com.amazonaws.bedrockruntime#GuardrailAutomatedReasoningPoliciesProcessed", + "traits": { + "smithy.api#documentation": "

The number of automated reasoning policies that were processed during the guardrail evaluation.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/bedrock.json b/codegen/sdk/aws-models/bedrock.json index a4e2fb74c3a..2d196839099 100644 --- a/codegen/sdk/aws-models/bedrock.json +++ b/codegen/sdk/aws-models/bedrock.json @@ -124,6 +124,9 @@ { "target": "com.amazonaws.bedrock#AllowlistResource" }, + { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + }, { "target": "com.amazonaws.bedrock#BedrockMarketplaceResource" }, @@ -1001,2429 +1004,2721 @@ } } }, - "com.amazonaws.bedrock#BaseModelIdentifier": { - "type": "string", + "com.amazonaws.bedrock#AutomatedReasoningCheckDifferenceScenarioList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckScenario" + }, "traits": { "smithy.api#length": { - "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})([:][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}){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][_-]?)+)$" + "max": 2 + } } }, - "com.amazonaws.bedrock#BatchDeleteEvaluationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" + "com.amazonaws.bedrock#AutomatedReasoningCheckFinding": { + "type": "union", + "members": { + "valid": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckValidFinding", + "traits": { + "smithy.api#documentation": "

Indicates that the claims are true. The claims are implied by the premises and the Automated Reasoning policy. Given the Automated Reasoning policy and premises, it is not possible for these claims to be false.

" + } }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" + "invalid": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckInvalidFinding", + "traits": { + "smithy.api#documentation": "

Indicates that the claims are false. The claims are not implied by the premises and Automated Reasoning policy. Furthermore, there exist different claims that are consistent with the premises and Automated Reasoning policy.

" + } }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" + "satisfiable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckSatisfiableFinding", + "traits": { + "smithy.api#documentation": "

Indicates that the claims can be true or false. It depends on what assumptions are made for the claim to be implied from the premises and Automated Reasoning policy rules. In this situation, different assumptions can make input claims false and alternative claims true.

" + } }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a batch of evaluation jobs. An evaluation job can only be deleted if it has following status FAILED, COMPLETED, and STOPPED. You can request up to 25 model evaluation jobs be deleted in a single request.

", - "smithy.api#examples": [ - { - "title": "Delete evaluation jobs", - "documentation": "The following example shows a request to delete two model evaluation jobs, where one of the jobs is not found.", - "input": { - "jobIdentifiers": [ - "arn:aws:bedrock:us-east-2:123456789012:evaluation-job/12rnxmplqv0v", - "arn:aws:bedrock:us-east-2:123456789012:evaluation-job/rispxmpl12rn" - ] - }, - "output": { - "evaluationJobs": [ - { - "jobIdentifier": "arn:aws:bedrock:us-east-2:123456789012:evaluation-job/12rnxmplqv0v", - "jobStatus": "Deleting" - } - ], - "errors": [ - { - "message": "Unable to locate this job to delete.", - "code": "404", - "jobIdentifier": "arn:aws:bedrock:us-east-2:123456789012:evaluation-job/rispxmpl12rn" - } - ] - } + "impossible": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckImpossibleFinding", + "traits": { + "smithy.api#documentation": "

Indicates that Automated Reasoning cannot make a statement about the claims. This can happen if the premises are logically incorrect, or if there is a conflict within the Automated Reasoning policy itself.

" } - ], - "smithy.api#http": { - "code": 202, - "method": "POST", - "uri": "/evaluation-jobs/batch-delete" - } - } - }, - "com.amazonaws.bedrock#BatchDeleteEvaluationJobError": { - "type": "structure", - "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + }, + "translationAmbiguous": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationAmbiguousFinding", "traits": { - "smithy.api#documentation": "

The ARN of the evaluation job being deleted.

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

Indicates that an ambiguity was detected in the translation, making it unsound to continue with validity checking. Additional context or follow-up questions might be needed to get translation to succeed.

" } }, - "code": { - "target": "smithy.api#String", + "tooComplex": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTooComplexFinding", "traits": { - "smithy.api#documentation": "

A HTTP status code of the evaluation job being deleted.

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

Indicates that the input contains too much information for Automated Reasoning to process within its latency limits.

" } }, - "message": { - "target": "smithy.api#String", + "noTranslations": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckNoTranslationsFinding", "traits": { - "smithy.api#documentation": "

A status message about the evaluation job deletion.

" + "smithy.api#documentation": "

Identifies that some or all of the input prompt wasn't translated into logic. This can happen if the input isn't relevant to the Automated Reasoning policy, or if the policy doesn't have variables to model relevant input.

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

A JSON array that provides the status of the evaluation jobs being deleted.

" + "smithy.api#documentation": "

Represents the result of an Automated Reasoning validation check, indicating whether the content is logically valid, invalid, or falls into other categories based on the policy rules.

" } }, - "com.amazonaws.bedrock#BatchDeleteEvaluationJobErrors": { + "com.amazonaws.bedrock#AutomatedReasoningCheckFindingList": { "type": "list", "member": { - "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobError" + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckFinding" }, "traits": { "smithy.api#length": { "min": 0, - "max": 25 + "max": 20 } } }, - "com.amazonaws.bedrock#BatchDeleteEvaluationJobItem": { + "com.amazonaws.bedrock#AutomatedReasoningCheckImpossibleFinding": { "type": "structure", "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + "translation": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslation", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the evaluation job for deletion.

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

The logical translation of the input that this finding evaluates.

" } }, - "jobStatus": { - "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "contradictingRules": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckRuleList", "traits": { - "smithy.api#documentation": "

The status of the evaluation job for deletion.

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

The automated reasoning policy rules that contradict the claims and/or premises in the input.

" + } + }, + "logicWarning": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarning", + "traits": { + "smithy.api#documentation": "

Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.

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

An evaluation job for deletion, and it’s current status.

" + "smithy.api#documentation": "

Indicates that no valid claims can be made due to logical contradictions in the premises or rules.

" } }, - "com.amazonaws.bedrock#BatchDeleteEvaluationJobItems": { + "com.amazonaws.bedrock#AutomatedReasoningCheckInputTextReference": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.bedrock#AutomatedReasoningNaturalLanguageStatementContent", + "traits": { + "smithy.api#documentation": "

The specific text from the original input that this reference points to.

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

References a portion of the original input text that corresponds to logical elements.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckInputTextReferenceList": { "type": "list", "member": { - "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobItem" + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckInputTextReference" } }, - "com.amazonaws.bedrock#BatchDeleteEvaluationJobRequest": { + "com.amazonaws.bedrock#AutomatedReasoningCheckInvalidFinding": { "type": "structure", "members": { - "jobIdentifiers": { - "target": "com.amazonaws.bedrock#EvaluationJobIdentifiers", + "translation": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslation", "traits": { - "smithy.api#documentation": "

A list of one or more evaluation job Amazon Resource Names (ARNs) you want to delete.

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

The logical translation of the input that this finding invalidates.

" + } + }, + "contradictingRules": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckRuleList", + "traits": { + "smithy.api#documentation": "

The automated reasoning policy rules that contradict the claims in the input.

" + } + }, + "logicWarning": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarning", + "traits": { + "smithy.api#documentation": "

Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.

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

Indicates that the claims are logically false and contradictory to the established rules or premises.

" } }, - "com.amazonaws.bedrock#BatchDeleteEvaluationJobResponse": { + "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarning": { "type": "structure", "members": { - "errors": { - "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobErrors", + "type": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarningType", "traits": { - "smithy.api#documentation": "

A JSON object containing the HTTP status codes and the ARNs of evaluation jobs that failed to be deleted.

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

The category of the detected logical issue, such as statements that are always true or always false.

" } }, - "evaluationJobs": { - "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobItems", + "premises": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatementList", "traits": { - "smithy.api#documentation": "

The list of evaluation jobs for deletion.

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

The logical statements that serve as premises under which the claims are validated.

" + } + }, + "claims": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatementList", + "traits": { + "smithy.api#documentation": "

The logical statements that are validated while assuming the policy and premises.

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

Identifies logical issues in the translated statements that exist independent of any policy rules, such as statements that are always true or always false.

" } }, - "com.amazonaws.bedrock#BedrockEvaluatorModel": { - "type": "structure", + "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarningType": { + "type": "enum", "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#EvaluatorModelIdentifier", + "ALWAYS_TRUE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the evaluator model used used in knowledge base evaluation job or in model evaluation job that use a model as judge.

", - "smithy.api#required": {} + "smithy.api#enumValue": "ALWAYS_TRUE" + } + }, + "ALWAYS_FALSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALWAYS_FALSE" } } - }, - "traits": { - "smithy.api#documentation": "

The evaluator model used in knowledge base evaluation job or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

" } }, - "com.amazonaws.bedrock#BedrockEvaluatorModels": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#BedrockEvaluatorModel" - }, + "com.amazonaws.bedrock#AutomatedReasoningCheckNoTranslationsFinding": { + "type": "structure", + "members": {}, "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } + "smithy.api#documentation": "

Indicates that no relevant logical information could be extracted from the input for validation.

" } }, - "com.amazonaws.bedrock#BedrockMarketplaceResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateMarketplaceModelEndpoint" + "com.amazonaws.bedrock#AutomatedReasoningCheckResult": { + "type": "enum", + "members": { + "VALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALID" + } }, - { - "target": "com.amazonaws.bedrock#DeleteMarketplaceModelEndpoint" + "INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID" + } }, - { - "target": "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpoint" + "SATISFIABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SATISFIABLE" + } }, - { - "target": "com.amazonaws.bedrock#GetMarketplaceModelEndpoint" + "IMPOSSIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPOSSIBLE" + } }, - { - "target": "com.amazonaws.bedrock#ListMarketplaceModelEndpoints" + "TRANSLATION_AMBIGUOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSLATION_AMBIGUOUS" + } }, - { - "target": "com.amazonaws.bedrock#RegisterMarketplaceModelEndpoint" + "TOO_COMPLEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOO_COMPLEX" + } }, - { - "target": "com.amazonaws.bedrock#UpdateMarketplaceModelEndpoint" + "NO_TRANSLATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_TRANSLATION" + } } - ] - }, - "com.amazonaws.bedrock#BedrockModelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" } }, - "com.amazonaws.bedrock#BedrockModelId": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 140 + "com.amazonaws.bedrock#AutomatedReasoningCheckRule": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the automated reasoning rule.

" + } }, - "smithy.api#pattern": "^[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)$" + "policyVersionArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the automated reasoning policy version that contains this rule.

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

References a specific automated reasoning policy rule that was applied during evaluation.

" } }, - "com.amazonaws.bedrock#BedrockRerankingModelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$" + "com.amazonaws.bedrock#AutomatedReasoningCheckRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckRule" } }, - "com.amazonaws.bedrock#BrandedName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrock#BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - } - } - }, - "com.amazonaws.bedrock#ByteContentBlob": { - "type": "blob", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10485760 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#ByteContentDoc": { + "com.amazonaws.bedrock#AutomatedReasoningCheckSatisfiableFinding": { "type": "structure", "members": { - "identifier": { - "target": "com.amazonaws.bedrock#Identifier", + "translation": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslation", "traits": { - "smithy.api#documentation": "

The file name of the document contained in the wrapper object.

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

The logical translation of the input that this finding evaluates.

" } }, - "contentType": { - "target": "com.amazonaws.bedrock#ContentType", + "claimsTrueScenario": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckScenario", "traits": { - "smithy.api#documentation": "

The MIME type of the document contained in the wrapper object.

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

An example scenario demonstrating how the claims could be logically true.

" } }, - "data": { - "target": "com.amazonaws.bedrock#ByteContentBlob", + "claimsFalseScenario": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckScenario", "traits": { - "smithy.api#documentation": "

The byte value of the file to upload, encoded as a Base-64 string.

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

An example scenario demonstrating how the claims could be logically false.

" + } + }, + "logicWarning": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarning", + "traits": { + "smithy.api#documentation": "

Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.

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

Contains the document contained in the wrapper object, along with its attributes/fields.

" + "smithy.api#documentation": "

Indicates that the claims could be either true or false depending on additional assumptions not provided in the input.

" } }, - "com.amazonaws.bedrock#CloudWatchConfig": { + "com.amazonaws.bedrock#AutomatedReasoningCheckScenario": { "type": "structure", "members": { - "logGroupName": { - "target": "com.amazonaws.bedrock#LogGroupName", + "statements": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatementList", "traits": { - "smithy.api#documentation": "

The log group name.

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

List of logical assignments and statements that define this scenario.

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

Represents a logical scenario where claims can be evaluated as true or false, containing specific logical assignments.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckTooComplexFinding": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Indicates that the input exceeds the processing capacity due to the volume or complexity of the logical information.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckTranslation": { + "type": "structure", + "members": { + "premises": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatementList", + "traits": { + "smithy.api#documentation": "

The logical statements that serve as the foundation or assumptions for the claims.

" } }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", + "claims": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatementList", "traits": { - "smithy.api#documentation": "

The role Amazon Resource Name (ARN).

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

The logical statements that are being validated against the premises and policy rules.

", "smithy.api#required": {} } }, - "largeDataDeliveryS3Config": { - "target": "com.amazonaws.bedrock#S3Config", + "untranslatedPremises": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckInputTextReferenceList", "traits": { - "smithy.api#documentation": "

S3 configuration for delivering a large amount of data.

" + "smithy.api#documentation": "

References to portions of the original input text that correspond to the premises but could not be fully translated.

" + } + }, + "untranslatedClaims": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckInputTextReferenceList", + "traits": { + "smithy.api#documentation": "

References to portions of the original input text that correspond to the claims but could not be fully translated.

" + } + }, + "confidence": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationConfidence", + "traits": { + "smithy.api#documentation": "

A confidence score between 0 and 1 indicating how certain the system is about the logical translation.

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

CloudWatch logging configuration.

" + "smithy.api#documentation": "

Contains the logical translation of natural language input into formal logical statements, including premises, claims, and confidence scores.

" } }, - "com.amazonaws.bedrock#CommitmentDuration": { - "type": "enum", + "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationAmbiguousFinding": { + "type": "structure", "members": { - "ONE_MONTH": { - "target": "smithy.api#Unit", + "options": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationOptionList", "traits": { - "smithy.api#enumValue": "OneMonth" + "smithy.api#documentation": "

Different logical interpretations that were detected during translation of the input.

" } }, - "SIX_MONTHS": { - "target": "smithy.api#Unit", + "differenceScenarios": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckDifferenceScenarioList", "traits": { - "smithy.api#enumValue": "SixMonths" + "smithy.api#documentation": "

Scenarios showing how the different translation options differ in meaning.

" } } - } - }, - "com.amazonaws.bedrock#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" - } }, "traits": { - "smithy.api#documentation": "

Error occurred because of a conflict while performing an operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#documentation": "

Indicates that the input has multiple valid logical interpretations, requiring additional context or clarification.

" } }, - "com.amazonaws.bedrock#ContentType": { - "type": "string", + "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationConfidence": { + "type": "double", "traits": { - "smithy.api#pattern": "[a-z]{1,20}/.{1,20}" + "smithy.api#range": { + "min": 0, + "max": 1 + } } }, - "com.amazonaws.bedrock#CreateCustomModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateCustomModelRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateCustomModelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" + "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslation" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationOption": { + "type": "structure", + "members": { + "translations": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationList", + "traits": { + "smithy.api#documentation": "

Different logical interpretations that were detected during translation of the input.

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

Creates a new custom model in Amazon Bedrock. After the model is active, you can use it for inference.

To use the model for inference, you must purchase Provisioned Throughput for it. You can't use On-demand inference with these custom models. For more information about Provisioned Throughput, see Provisioned Throughput.

The model appears in ListCustomModels with a customizationType of imported. To track the status of the new model, you use the GetCustomModel API operation. The model can be in the following states:

  • Creating - Initial state during validation and registration

  • Active - Model is ready for use in inference

  • Failed - Creation process encountered an error

Related APIs

", - "smithy.api#examples": [ - { - "title": "Successful CreateCustomModel API call", - "input": { - "modelName": "SampleModel", - "modelSourceConfig": { - "s3DataSource": { - "s3Uri": "s3://my-bucket/folder" - } - }, - "roleArn": "arn:aws:iam::123456789012:role/SampleRole", - "modelKmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", - "modelTags": [ - { - "key": "foo", - "value": "foo" - }, - { - "key": "foo", - "value": "foo" - } - ], - "clientRequestToken": "foo" - }, - "output": { - "modelArn": "arn:aws:bedrock:us-east-1:123456789012:custom-model/imported/abcdef123456" - } - } - ], - "smithy.api#http": { - "code": 202, - "method": "POST", - "uri": "/custom-models/create-custom-model" - }, - "smithy.api#idempotent": {} + "smithy.api#documentation": "

Represents one possible logical interpretation of ambiguous input content.

" } }, - "com.amazonaws.bedrock#CreateCustomModelDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateCustomModelDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateCustomModelDeploymentResponse" + "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationOption" }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "

Deploys a custom model for on-demand inference in Amazon Bedrock. After you deploy your custom model, you use the deployment's Amazon Resource Name (ARN) as the modelId parameter when you submit prompts and generate responses with model inference.

For more information about setting up on-demand inference for custom models, see Set up inference for a custom model.

The following actions are related to the CreateCustomModelDeployment operation:

", - "smithy.api#http": { - "code": 202, - "method": "POST", - "uri": "/model-customization/custom-model-deployments" - }, - "smithy.api#idempotent": {} + "smithy.api#length": { + "max": 2 + } } }, - "com.amazonaws.bedrock#CreateCustomModelDeploymentRequest": { + "com.amazonaws.bedrock#AutomatedReasoningCheckValidFinding": { "type": "structure", "members": { - "modelDeploymentName": { - "target": "com.amazonaws.bedrock#ModelDeploymentName", - "traits": { - "smithy.api#documentation": "

The name for the custom model deployment. The name must be unique within your Amazon Web Services account and Region.

", - "smithy.api#required": {} - } - }, - "modelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", + "translation": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslation", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model to deploy for on-demand inference. The custom model must be in the Active state.

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

The logical translation of the input that this finding validates.

" } }, - "description": { - "target": "com.amazonaws.bedrock#CustomModelDeploymentDescription", + "claimsTrueScenario": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckScenario", "traits": { - "smithy.api#documentation": "

A description for the custom model deployment to help you identify its purpose.

" + "smithy.api#documentation": "

An example scenario demonstrating how the claims are logically true.

" } }, - "tags": { - "target": "com.amazonaws.bedrock#TagList", + "supportingRules": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckRuleList", "traits": { - "smithy.api#documentation": "

Tags to assign to the custom model deployment. You can use tags to organize and track your Amazon Web Services resources for cost allocation and management purposes.

" + "smithy.api#documentation": "

The automated reasoning policy rules that support why this result is considered valid.

" } }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", + "logicWarning": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckLogicWarning", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.

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

Indicates that the claims are definitively true and logically implied by the premises, with no possible alternative interpretations.

" } }, - "com.amazonaws.bedrock#CreateCustomModelDeploymentResponse": { + "com.amazonaws.bedrock#AutomatedReasoningConfidenceFilterThreshold": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningLogicStatement": { "type": "structure", "members": { - "customModelDeploymentArn": { - "target": "com.amazonaws.bedrock#CustomModelDeploymentArn", + "logic": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatementContent", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model deployment. Use this ARN as the modelId parameter when invoking the model with the InvokeModel or Converse operations.

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

The formal logic representation of the statement using mathematical notation and logical operators.

", "smithy.api#required": {} } + }, + "naturalLanguage": { + "target": "com.amazonaws.bedrock#AutomatedReasoningNaturalLanguageStatementContent", + "traits": { + "smithy.api#documentation": "

The natural language representation of the logical statement, providing a human-readable interpretation of the formal logic.

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

Represents a logical statement that can be expressed both in formal logic notation and natural language, providing dual representations for better understanding and validation.

" } }, - "com.amazonaws.bedrock#CreateCustomModelRequest": { + "com.amazonaws.bedrock#AutomatedReasoningLogicStatementContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningLogicStatementList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningLogicStatement" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningNaturalLanguageStatementContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddRuleAnnotation": { "type": "structure", "members": { - "modelName": { - "target": "com.amazonaws.bedrock#CustomModelName", + "expression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleExpression", "traits": { - "smithy.api#documentation": "

A unique name for the custom model.

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

The formal logical expression that defines the rule, using mathematical notation and referencing policy variables and types.

", "smithy.api#required": {} } - }, - "modelSourceConfig": { - "target": "com.amazonaws.bedrock#ModelDataSource", + } + }, + "traits": { + "smithy.api#documentation": "

An annotation for adding a new rule to an Automated Reasoning policy using a formal logical expression.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation": { + "type": "structure", + "members": { + "naturalLanguage": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationRuleNaturalLanguage", "traits": { - "smithy.api#documentation": "

The data source for the model. The Amazon S3 URI in the model source must be for the Amazon-managed Amazon S3 bucket containing your model artifacts.

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

The natural language description of the rule that should be converted into a formal logical expression.

", "smithy.api#required": {} } - }, - "modelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", + } + }, + "traits": { + "smithy.api#documentation": "

An annotation for adding a new rule to the policy by converting a natural language description into a formal logical expression.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddRuleMutation": { + "type": "structure", + "members": { + "rule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer managed KMS key to encrypt the custom model. If you don't provide a KMS key, Amazon Bedrock uses an Amazon Web Services-managed KMS key to encrypt the model.

If you provide a customer managed KMS key, your Amazon Bedrock service role must have permissions to use it. For more information see Encryption of imported models.

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

A mutation operation that adds a new rule to the policy definition during the build process.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddTypeAnnotation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock assumes to perform tasks on your behalf. This role must have permissions to access the Amazon S3 bucket containing your model artifacts and the KMS key (if specified). For more information, see Setting up an IAM service role for importing models in the Amazon Bedrock User Guide.

" + "smithy.api#documentation": "

The name of the new custom type. This name will be used to reference the type in variable definitions and rules.

", + "smithy.api#required": {} } }, - "modelTags": { - "target": "com.amazonaws.bedrock#TagList", + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeDescription", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to associate with the custom model resource. You can use these tags to organize and identify your resources.

For more information, see Tagging resources in the Amazon Bedrock User Guide.

" + "smithy.api#documentation": "

A description of what the custom type represents and how it should be used in the policy.

", + "smithy.api#required": {} } }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", + "values": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueList", "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

The list of possible values that variables of this type can take, each with its own description and identifier.

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

An annotation for adding a new custom type to an Automated Reasoning policy, defining a set of possible values for variables.

" } }, - "com.amazonaws.bedrock#CreateCustomModelResponse": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddTypeMutation": { "type": "structure", "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + "type": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new custom model.

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

A mutation operation that adds a new custom type to the policy definition during the build process.

" } }, - "com.amazonaws.bedrock#CreateEvaluationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateEvaluationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateEvaluationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddTypeValue": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName", + "traits": { + "smithy.api#documentation": "

The identifier or name of the new value to add to the type.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueDescription", + "traits": { + "smithy.api#documentation": "

A description of what this new type value represents and when it should be used.

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

Represents a single value that can be added to an existing custom type in the policy.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddVariableAnnotation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName", + "traits": { + "smithy.api#documentation": "

The name of the new variable. This name will be used to reference the variable in rule expressions.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" + "type": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", + "traits": { + "smithy.api#documentation": "

The type of the variable, which can be a built-in type (like string or number) or a custom type defined in the policy.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ValidationException" + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableDescription", + "traits": { + "smithy.api#documentation": "

A description of what the variable represents and how it should be used in rules.

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

Creates an evaluation job.

", - "smithy.api#http": { - "code": 202, - "method": "POST", - "uri": "/evaluation-jobs" - }, - "smithy.api#idempotent": {} + "smithy.api#documentation": "

An annotation for adding a new variable to an Automated Reasoning policy, which can be used in rule expressions.

" } }, - "com.amazonaws.bedrock#CreateEvaluationJobRequest": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyAddVariableMutation": { "type": "structure", "members": { - "jobName": { - "target": "com.amazonaws.bedrock#EvaluationJobName", + "variable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable", "traits": { - "smithy.api#documentation": "

A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account's Amazon Web Services region.

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

A mutation operation that adds a new variable to the policy definition during the build process.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotation": { + "type": "union", + "members": { + "addType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddTypeAnnotation", + "traits": { + "smithy.api#documentation": "

An operation to add a new custom type to the policy, defining a set of possible values for policy variables.

" + } }, - "jobDescription": { - "target": "com.amazonaws.bedrock#EvaluationJobDescription", + "updateType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateTypeAnnotation", "traits": { - "smithy.api#documentation": "

A description of the evaluation job.

" + "smithy.api#documentation": "

An operation to modify an existing custom type in the policy, such as changing its name, description, or allowed values.

" } }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", + "deleteType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteTypeAnnotation", "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

An operation to remove a custom type from the policy. The type must not be referenced by any variables or rules.

" } }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", + "addVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddVariableAnnotation", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see Required permissions for model evaluations.

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

An operation to add a new variable to the policy, which can be used in rule expressions to represent dynamic values.

" } }, - "customerEncryptionKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", + "updateVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateVariableAnnotation", "traits": { - "smithy.api#documentation": "

Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.

" + "smithy.api#documentation": "

An operation to modify an existing variable in the policy, such as changing its name, type, or description.

" } }, - "jobTags": { - "target": "com.amazonaws.bedrock#TagList", + "deleteVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteVariableAnnotation", "traits": { - "smithy.api#documentation": "

Tags to attach to the model evaluation job.

" + "smithy.api#documentation": "

An operation to remove a variable from the policy. The variable must not be referenced by any rules.

" } }, - "applicationType": { - "target": "com.amazonaws.bedrock#ApplicationType", + "addRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddRuleAnnotation", "traits": { - "smithy.api#documentation": "

Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

" + "smithy.api#documentation": "

An operation to add a new logical rule to the policy using formal mathematical expressions.

" } }, - "evaluationConfig": { - "target": "com.amazonaws.bedrock#EvaluationConfig", + "updateRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateRuleAnnotation", "traits": { - "smithy.api#documentation": "

Contains the configuration details of either an automated or human-based evaluation job.

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

An operation to modify an existing rule in the policy, such as changing its logical expression or conditions.

" } }, - "inferenceConfig": { - "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", + "deleteRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteRuleAnnotation", "traits": { - "smithy.api#documentation": "

Contains the configuration details of the inference model for the evaluation job.

For model evaluation jobs, automated jobs support a single model or inference profile, and jobs that use human workers support two models or inference profiles.

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

An operation to remove a rule from the policy.

" } }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", + "addRuleFromNaturalLanguage": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation", "traits": { - "smithy.api#documentation": "

Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

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

An operation to add a new rule by converting natural language descriptions into formal logical expressions.

" + } + }, + "updateFromRulesFeedback": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation", + "traits": { + "smithy.api#documentation": "

An operation to update the policy based on feedback about how specific rules performed during testing or validation.

" + } + }, + "updateFromScenarioFeedback": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation", + "traits": { + "smithy.api#documentation": "

An operation to update the policy based on feedback about how it performed on specific test scenarios.

" + } + }, + "ingestContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyIngestContentAnnotation", + "traits": { + "smithy.api#documentation": "

An operation to process and incorporate new content into the policy, extracting additional rules and concepts.

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

Contains the various operations that can be performed on an Automated Reasoning policy, including adding, updating, and deleting rules, variables, and types.

" } }, - "com.amazonaws.bedrock#CreateEvaluationJobResponse": { - "type": "structure", + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationFeedbackNaturalLanguage": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationIngestContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 4096 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationRuleNaturalLanguage": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationStatus": { + "type": "enum", "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#EvaluationJobArn", + "APPLIED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the evaluation job.

", - "smithy.api#required": {} + "smithy.api#enumValue": "APPLIED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } } - }, - "traits": { - "smithy.api#output": {} } }, - "com.amazonaws.bedrock#CreateFoundationModelAgreement": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateFoundationModelAgreementRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateFoundationModelAgreementResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], + "com.amazonaws.bedrock#AutomatedReasoningPolicyArn": { + "type": "string", "traits": { - "smithy.api#documentation": "

Request a model access agreement for the specified model.

", - "smithy.api#http": { - "code": 202, - "method": "POST", - "uri": "/create-foundation-model-agreement" - } + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?$" } }, - "com.amazonaws.bedrock#CreateFoundationModelAgreementRequest": { - "type": "structure", + "com.amazonaws.bedrock#AutomatedReasoningPolicyArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentContentType": { + "type": "enum", "members": { - "offerToken": { - "target": "com.amazonaws.bedrock#OfferToken", + "PDF": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

An offer token encapsulates the information for an offer.

", - "smithy.api#required": {} + "smithy.api#enumValue": "pdf" } }, - "modelId": { - "target": "com.amazonaws.bedrock#BedrockModelId", + "TEXT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Model Id of the model for the access request.

", - "smithy.api#required": {} + "smithy.api#enumValue": "txt" } } - }, + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentDescription": { + "type": "string", "traits": { - "smithy.api#input": {} + "smithy.api#length": { + "max": 2000 + }, + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrock#CreateFoundationModelAgreementResponse": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildLog": { "type": "structure", "members": { - "modelId": { - "target": "com.amazonaws.bedrock#BedrockModelId", + "entries": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildLogEntryList", "traits": { - "smithy.api#documentation": "

Model Id of the model for the access request.

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

A list of log entries documenting each step in the policy build process, including timestamps, status, and detailed messages.

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

Contains detailed logging information about the policy build process, including steps taken, decisions made, and any issues encountered.

" } }, - "com.amazonaws.bedrock#CreateGuardrail": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateGuardrailRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateGuardrailResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildLogEntry": { + "type": "structure", + "members": { + "annotation": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotation", + "traits": { + "smithy.api#documentation": "

The annotation or operation that was being processed when this log entry was created.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" + "status": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationStatus", + "traits": { + "smithy.api#documentation": "

The status of the build step (e.g., SUCCESS, FAILED, IN_PROGRESS).

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ValidationException" + "buildSteps": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepList", + "traits": { + "smithy.api#documentation": "

Detailed information about the specific build steps that were executed, including any sub-operations or transformations.

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

Creates a guardrail to block topics and to implement safeguards for your generative AI applications.

You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.

  • Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.

  • Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.

  • Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.

  • Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.

In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.

For more information, see Amazon Bedrock Guardrails in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 202, - "method": "POST", - "uri": "/guardrails" - } + "smithy.api#documentation": "

Represents a single entry in the policy build log, containing information about a specific step or event in the build process.

" } }, - "com.amazonaws.bedrock#CreateGuardrailRequest": { - "type": "structure", + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildLogEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildLogEntry" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildMessageType": { + "type": "enum", "members": { - "name": { - "target": "com.amazonaws.bedrock#GuardrailName", + "INFO": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The name to give the guardrail.

", - "smithy.api#required": {} + "smithy.api#enumValue": "INFO" } }, - "description": { - "target": "com.amazonaws.bedrock#GuardrailDescription", + "WARNING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A description of the guardrail.

" + "smithy.api#enumValue": "WARNING" } }, - "topicPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailTopicPolicyConfig", + "ERROR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The topic policies to configure for the guardrail.

" + "smithy.api#enumValue": "ERROR" } - }, - "contentPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailContentPolicyConfig", + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetType": { + "type": "enum", + "members": { + "BUILD_LOG": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The content filter policies to configure for the guardrail.

" + "smithy.api#enumValue": "BUILD_LOG" } }, - "wordPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailWordPolicyConfig", + "QUALITY_REPORT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The word policy you configure for the guardrail.

" + "smithy.api#enumValue": "QUALITY_REPORT" } }, - "sensitiveInformationPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig", + "POLICY_DEFINITION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The sensitive information policy to configure for the guardrail.

" + "smithy.api#enumValue": "POLICY_DEFINITION" } + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssets": { + "type": "union", + "members": { + "policyDefinition": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition" }, - "contextualGroundingPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig", + "qualityReport": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionQualityReport", "traits": { - "smithy.api#documentation": "

The contextual grounding policy configuration used to create a guardrail.

" + "smithy.api#documentation": "

A comprehensive report analyzing the quality of the generated policy, including metrics about rule coverage, potential conflicts, and unused elements.

" } }, - "crossRegionConfig": { - "target": "com.amazonaws.bedrock#GuardrailCrossRegionConfig", + "buildLog": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildLog", "traits": { - "smithy.api#documentation": "

The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.

For more information, see the Amazon Bedrock User Guide.

" + "smithy.api#documentation": "

The complete build log containing detailed information about each step in the policy generation process.

" } - }, - "blockedInputMessaging": { - "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + } + }, + "traits": { + "smithy.api#documentation": "

Contains the various assets generated during a policy build workflow, including logs, quality reports, and the final policy definition.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStep": { + "type": "structure", + "members": { + "context": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepContext", "traits": { - "smithy.api#documentation": "

The message to return when the guardrail blocks a prompt.

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

Contextual information about what was being processed during this build step, such as the type of operation or the source material being analyzed.

", "smithy.api#required": {} } }, - "blockedOutputsMessaging": { - "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "priorElement": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionElement", "traits": { - "smithy.api#documentation": "

The message to return when the guardrail blocks a model response.

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

Reference to the previous element or step in the build process, helping to trace the sequence of operations.

" } }, - "kmsKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", + "messages": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepMessageList", "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that you use to encrypt the guardrail.

" + "smithy.api#documentation": "

A list of messages generated during this build step, including informational messages, warnings, and error details.

", + "smithy.api#required": {} } - }, - "tags": { - "target": "com.amazonaws.bedrock#TagList", + } + }, + "traits": { + "smithy.api#documentation": "

Represents a single step in the policy build process, containing context about what was being processed and any messages or results.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepContext": { + "type": "union", + "members": { + "planning": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyPlanning", "traits": { - "smithy.api#documentation": "

The tags that you want to attach to the guardrail.

" + "smithy.api#documentation": "

Indicates that this build step was part of the planning phase, where the system determines what operations to perform.

" } }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", + "mutation": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyMutation", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

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

Indicates that this build step involved modifying the policy structure, such as adding or updating rules, variables, or types.

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

Provides context about what type of operation was being performed during a build step.

" } }, - "com.amazonaws.bedrock#CreateGuardrailResponse": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStep" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepMessage": { "type": "structure", "members": { - "guardrailId": { - "target": "com.amazonaws.bedrock#GuardrailId", + "message": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail that was created.

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

The content of the message, describing what occurred during the build step.

", "smithy.api#required": {} } }, - "guardrailArn": { - "target": "com.amazonaws.bedrock#GuardrailArn", + "messageType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildMessageType", "traits": { - "smithy.api#documentation": "

The ARN of the guardrail.

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

The type of message (e.g., INFO, WARNING, ERROR) indicating its severity and purpose.

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

Represents a message generated during a build step, providing information about what happened or any issues encountered.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepMessageList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildStepMessage" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowDocument": { + "type": "structure", + "members": { + "document": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "

The actual content of the source document that will be analyzed to extract policy rules and concepts.

", + "smithy.api#length": { + "min": 1, + "max": 4500000 + }, "smithy.api#required": {} } }, - "version": { - "target": "com.amazonaws.bedrock#GuardrailDraftVersion", + "documentContentType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentContentType", "traits": { - "smithy.api#documentation": "

The version of the guardrail that was created. This value will always be DRAFT.

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

The MIME type of the document content (e.g., text/plain, application/pdf, text/markdown).

", "smithy.api#required": {} } }, - "createdAt": { - "target": "com.amazonaws.bedrock#Timestamp", + "documentName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentName", "traits": { - "smithy.api#documentation": "

The time at which the guardrail was created.

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

A descriptive name for the document that helps identify its purpose and content.

", "smithy.api#required": {} } + }, + "documentDescription": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentDescription", + "traits": { + "smithy.api#documentation": "

A detailed description of the document's content and how it should be used in the policy generation process.

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

Represents a source document used in the policy build workflow, containing the content and metadata needed for policy generation.

" } }, - "com.amazonaws.bedrock#CreateGuardrailVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateGuardrailVersionRequest" + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowDocumentList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowDocument" }, - "output": { - "target": "com.amazonaws.bedrock#CreateGuardrailVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "

Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.

", - "smithy.api#http": { - "code": 202, - "method": "POST", - "uri": "/guardrails/{guardrailIdentifier}" + "smithy.api#length": { + "min": 1, + "max": 1 } } }, - "com.amazonaws.bedrock#CreateGuardrailVersionRequest": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowRepairContent": { "type": "structure", "members": { - "guardrailIdentifier": { - "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "annotations": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationList", "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

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

Specific annotations or modifications to apply during the policy repair process, such as rule corrections or variable updates.

", "smithy.api#required": {} } - }, - "description": { - "target": "com.amazonaws.bedrock#GuardrailDescription", - "traits": { - "smithy.api#documentation": "

A description of the guardrail version.

" - } - }, - "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 once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

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

Contains content and instructions for repairing or improving an existing Automated Reasoning policy.

" } }, - "com.amazonaws.bedrock#CreateGuardrailVersionResponse": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowSource": { "type": "structure", "members": { - "guardrailId": { - "target": "com.amazonaws.bedrock#GuardrailId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail.

", - "smithy.api#required": {} - } + "policyDefinition": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition" }, - "version": { - "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", + "workflowContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyWorkflowTypeContent", "traits": { - "smithy.api#documentation": "

The number of the version of the guardrail.

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

The actual content to be processed in the build workflow, such as documents to analyze or repair instructions to apply.

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

Defines the source content for a policy build workflow, which can include documents, repair instructions, or other input materials.

" } }, - "com.amazonaws.bedrock#CreateInferenceProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateInferenceProfileRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateInferenceProfileResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowStatus": { + "type": "enum", + "members": { + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" + } }, - { - "target": "com.amazonaws.bedrock#ConflictException" + "CANCEL_REQUESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL_REQUESTED" + } }, - { - "target": "com.amazonaws.bedrock#InternalServerException" + "PREPROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREPROCESSING" + } }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" + "BUILDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUILDING" + } }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + "TESTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TESTING" + } }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } }, - { - "target": "com.amazonaws.bedrock#ValidationException" + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } } - ], + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowSummary" + }, "traits": { - "smithy.api#documentation": "

Creates an application inference profile to track metrics and costs when invoking a model. To create an application inference profile for a foundation model in one region, specify the ARN of the model in that region. To create an application inference profile for a foundation model across multiple regions, specify the ARN of the system-defined inference profile that contains the regions that you want to route requests to. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/inference-profiles" - }, - "smithy.api#idempotent": {} + "smithy.api#length": { + "min": 0, + "max": 1000 + } } }, - "com.amazonaws.bedrock#CreateInferenceProfileRequest": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowSummary": { "type": "structure", "members": { - "inferenceProfileName": { - "target": "com.amazonaws.bedrock#InferenceProfileName", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

A name for the inference profile.

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

The Amazon Resource Name (ARN) of the Automated Reasoning policy associated with this build workflow.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.bedrock#InferenceProfileDescription", + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", "traits": { - "smithy.api#documentation": "

A description for the inference profile.

" + "smithy.api#documentation": "

The unique identifier of the build workflow.

", + "smithy.api#required": {} } }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", + "status": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowStatus", "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

The current status of the build workflow (e.g., RUNNING, COMPLETED, FAILED, CANCELLED).

", + "smithy.api#required": {} } }, - "modelSource": { - "target": "com.amazonaws.bedrock#InferenceProfileModelSource", + "buildWorkflowType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowType", "traits": { - "smithy.api#documentation": "

The foundation model or system-defined inference profile that the inference profile will track metrics and costs for.

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

The type of build workflow (e.g., DOCUMENT_INGESTION, POLICY_REPAIR).

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.bedrock#TagList", + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

An array of objects, each of which contains a tag and its value. For more information, see Tagging resources in the Amazon Bedrock User Guide.

" + "smithy.api#documentation": "

The timestamp when the build workflow was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the build workflow was last updated.

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

Provides a summary of a policy build workflow, including its current status, timing information, and key identifiers.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] } }, - "com.amazonaws.bedrock#CreateInferenceProfileResponse": { - "type": "structure", + "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowType": { + "type": "enum", "members": { - "inferenceProfileArn": { - "target": "com.amazonaws.bedrock#InferenceProfileArn", + "INGEST_CONTENT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The ARN of the inference profile that you created.

", - "smithy.api#required": {} + "smithy.api#enumValue": "INGEST_CONTENT" } }, - "status": { - "target": "com.amazonaws.bedrock#InferenceProfileStatus", + "REFINE_POLICY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The status of the inference profile. ACTIVE means that the inference profile is ready to be used.

" + "smithy.api#enumValue": "REFINE_POLICY" + } + }, + "IMPORT_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_POLICY" } } - }, - "traits": { - "smithy.api#output": {} } }, - "com.amazonaws.bedrock#CreateMarketplaceModelEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateMarketplaceModelEndpointRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateMarketplaceModelEndpointResponse" + "com.amazonaws.bedrock#AutomatedReasoningPolicyConflictedRuleIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId" }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "

Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/marketplace-model/endpoints" + "smithy.api#length": { + "min": 0, + "max": 500 } } }, - "com.amazonaws.bedrock#CreateMarketplaceModelEndpointRequest": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition": { "type": "structure", "members": { - "modelSourceIdentifier": { - "target": "com.amazonaws.bedrock#ModelSourceIdentifier", + "version": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyFormatVersion", "traits": { - "smithy.api#documentation": "

The ARN of the model from Amazon Bedrock Marketplace that you want to deploy to the endpoint.

", - "smithy.api#required": {} + "smithy.api#default": "1", + "smithy.api#documentation": "

The version of the policy definition format.

" } }, - "endpointConfig": { - "target": "com.amazonaws.bedrock#EndpointConfig", + "types": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeList", "traits": { - "smithy.api#documentation": "

The configuration for the endpoint, including the number and type of instances to use.

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

The custom user-defined vairable types used in the policy. Types are enum-based variable types that provide additional context beyond the predefined variable types.

" } }, - "acceptEula": { - "target": "com.amazonaws.bedrock#AcceptEula", + "rules": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleList", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether you accept the end-user license agreement (EULA) for the model. Set to true to accept the EULA.

" + "smithy.api#documentation": "

The formal logic rules extracted from the source document. Rules define the logical constraints that determine whether model responses are valid, invalid, or satisfiable.

" } }, - "endpointName": { - "target": "com.amazonaws.bedrock#EndpointName", + "variables": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableList", "traits": { - "smithy.api#documentation": "

The name of the endpoint. This name must be unique within your Amazon Web Services account and region.

", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is listed as not required because Amazon Web Services SDKs automatically generate it for you and set this parameter. If you're not using the Amazon Web Services SDK or the CLI, you must provide this token or the action will fail.

", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

An array of key-value pairs to apply to the underlying Amazon SageMaker endpoint. You can use these tags to organize and identify your Amazon Web Services resources.

" + "smithy.api#documentation": "

The variables that represent concepts in the policy. Variables can have values assigned when translating natural language into formal logic. Their descriptions are crucial for accurate translation.

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

Contains the formal logic rules, variables, and custom variable types that define an Automated Reasoning policy. The policy definition specifies the constraints used to validate foundation model responses for accuracy and logical consistency.

" } }, - "com.amazonaws.bedrock#CreateMarketplaceModelEndpointResponse": { - "type": "structure", + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionElement": { + "type": "union", "members": { - "marketplaceModelEndpoint": { - "target": "com.amazonaws.bedrock#MarketplaceModelEndpoint", - "traits": { - "smithy.api#documentation": "

Details about the created endpoint.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#CreateModelCopyJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateModelCopyJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateModelCopyJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" + "policyDefinitionVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable" }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" + "policyDefinitionType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType" }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" + "policyDefinitionRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule" } - ], + }, "traits": { - "smithy.api#documentation": "

Copies a model to another region so that it can be used there. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/model-copy-jobs" - }, - "smithy.api#idempotent": {} + "smithy.api#documentation": "

Represents a single element in an Automated Reasoning policy definition, such as a rule, variable, or type definition.

" } }, - "com.amazonaws.bedrock#CreateModelCopyJobRequest": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionQualityReport": { "type": "structure", "members": { - "sourceModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + "typeCount": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model to be copied.

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

The total number of custom types defined in the policy.

", "smithy.api#required": {} } }, - "targetModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", + "variableCount": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

A name for the copied model.

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

The total number of variables defined in the policy.

", "smithy.api#required": {} } }, - "modelKmsKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", + "ruleCount": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that you use to encrypt the model copy.

" + "smithy.api#documentation": "

The total number of rules defined in the policy.

", + "smithy.api#required": {} } }, - "targetModelTags": { - "target": "com.amazonaws.bedrock#TagList", + "unusedTypes": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeNameList", "traits": { - "smithy.api#documentation": "

Tags to associate with the target model. For more information, see Tag resources in the Amazon Bedrock User Guide.

" + "smithy.api#documentation": "

A list of custom types that are defined but not referenced by any variables or rules, suggesting they may be unnecessary.

", + "smithy.api#required": {} } }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", + "unusedTypeValues": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValuePairList", "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

A list of type values that are defined but never used in any rules, indicating potential cleanup opportunities.

", + "smithy.api#required": {} + } + }, + "unusedVariables": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableNameList", + "traits": { + "smithy.api#documentation": "

A list of variables that are defined but not referenced by any rules, suggesting they may be unnecessary.

", + "smithy.api#required": {} + } + }, + "conflictingRules": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyConflictedRuleIdList", + "traits": { + "smithy.api#documentation": "

A list of rules that may conflict with each other, potentially leading to inconsistent policy behavior.

", + "smithy.api#required": {} + } + }, + "disjointRuleSets": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDisjointRuleSetList", + "traits": { + "smithy.api#documentation": "

Groups of rules that operate on completely separate sets of variables, indicating the policy may be addressing multiple unrelated concerns.

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

Provides a comprehensive analysis of the quality and completeness of an Automated Reasoning policy definition, highlighting potential issues and optimization opportunities.

" } }, - "com.amazonaws.bedrock#CreateModelCopyJobResponse": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule": { "type": "structure", "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "id": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model copy job.

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

The unique identifier of the rule within the policy.

", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleExpression", + "traits": { + "smithy.api#documentation": "

The formal logic expression of the rule.

", "smithy.api#required": {} } + }, + "alternateExpression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleAlternateExpression", + "traits": { + "smithy.api#documentation": "

The human-readable form of the rule expression, often in natural language or simplified notation.

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

Represents a formal logic rule in an Automated Reasoning policy. For example, rules can be expressed as if-then statements that define logical constraints.

" } }, - "com.amazonaws.bedrock#CreateModelCustomizationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateModelCustomizationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateModelCustomizationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleAlternateExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 }, - { - "target": "com.amazonaws.bedrock#ValidationException" + "smithy.api#pattern": "^[A-Z][0-9A-Z]{11}$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 } - ], + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule" + }, "traits": { - "smithy.api#documentation": "

Creates a fine-tuning job to customize a base model.

You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.

For information on the format of training and validation data, see Prepare the datasets.

Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.

For more information, see Custom models in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/model-customization-jobs" - }, - "smithy.api#idempotent": {} + "smithy.api#length": { + "min": 0, + "max": 1500 + } } }, - "com.amazonaws.bedrock#CreateModelCustomizationJobRequest": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType": { "type": "structure", "members": { - "jobName": { - "target": "com.amazonaws.bedrock#JobName", + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", "traits": { - "smithy.api#documentation": "

A name for the fine-tuning job.

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

The name of the custom type.

", "smithy.api#required": {} } }, - "customModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeDescription", "traits": { - "smithy.api#documentation": "

A name for the resulting custom model.

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

The description of what the custom type represents.

" } }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", + "values": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.

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

The possible values for this enum-based type, each with its own description.

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

Represents a custom user-defined viarble type in an Automated Reasoning policy. Types are enum-based and provide additional context beyond predefined variable types.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 }, - "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", - "smithy.api#idempotencyToken": {} - } + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 }, - "baseModelIdentifier": { - "target": "com.amazonaws.bedrock#BaseModelIdentifier", + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValue": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName", "traits": { - "smithy.api#documentation": "

Name of the base model.

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

The actual value or identifier for this type value.

", "smithy.api#required": {} } }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", - "traits": { - "smithy.api#documentation": "

The customization type.

" - } - }, - "customModelKmsKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueDescription", "traits": { - "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" + "smithy.api#documentation": "

A human-readable description explaining what this type value represents and when it should be used.

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

Represents a single value within a custom type definition, including its identifier and description.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 }, - "jobTags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

Tags to attach to the job.

" - } + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 150 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 }, - "customModelTags": { - "target": "com.amazonaws.bedrock#TagList", + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_]*$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValuePair": { + "type": "structure", + "members": { + "typeName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", "traits": { - "smithy.api#documentation": "

Tags to attach to the resulting custom model.

" + "smithy.api#documentation": "

The name of the custom type that contains the referenced value.

", + "smithy.api#required": {} } }, - "trainingDataConfig": { - "target": "com.amazonaws.bedrock#TrainingDataConfig", + "valueName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName", "traits": { - "smithy.api#documentation": "

Information about the training dataset.

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

The name of the specific value within the type.

", "smithy.api#required": {} } - }, - "validationDataConfig": { - "target": "com.amazonaws.bedrock#ValidationDataConfig", + } + }, + "traits": { + "smithy.api#documentation": "

Associates a type name with a specific value name, used for referencing type values in rules and other policy elements.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValuePairList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValuePair" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 22500 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName", "traits": { - "smithy.api#documentation": "

Information about the validation dataset.

" + "smithy.api#documentation": "

The name of the variable. Use descriptive names that clearly indicate the concept being represented.

", + "smithy.api#required": {} } }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#OutputDataConfig", + "type": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", "traits": { - "smithy.api#documentation": "

S3 location for the output data.

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

The data type of the variable. Valid types include bool, int, real, enum, and custom types that you can provide.

", "smithy.api#required": {} } }, - "hyperParameters": { - "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableDescription", "traits": { - "smithy.api#documentation": "

Parameters related to tuning the model. For details on the format for different models, see Custom model hyperparameters.

" + "smithy.api#documentation": "

The description of the variable that explains what it represents and how users might refer to it. Clear and comprehensive descriptions are essential for accurate natural language translation.

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

Represents a variable in an Automated Reasoning policy. Variables represent concepts that can have values assigned during natural language translation.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 }, - "vpcConfig": { - "target": "com.amazonaws.bedrock#VpcConfig", - "traits": { - "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) that contains the resources that you're using for this job. For more information, see Protect your model customization jobs using a VPC.

" - } + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 600 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 }, - "customizationConfig": { - "target": "com.amazonaws.bedrock#CustomizationConfig", + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 600 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteRuleAnnotation": { + "type": "structure", + "members": { + "ruleId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId", "traits": { - "smithy.api#documentation": "

The customization configuration for the model customization job.

" + "smithy.api#documentation": "

The unique identifier of the rule to delete from the policy.

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

An annotation for removing a rule from an Automated Reasoning policy.

" } }, - "com.amazonaws.bedrock#CreateModelCustomizationJobResponse": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteRuleMutation": { "type": "structure", "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "id": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the fine tuning job

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

The unique identifier of the rule to delete.

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

A mutation operation that removes a rule from the policy definition during the build process.

" } }, - "com.amazonaws.bedrock#CreateModelImportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateModelImportJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateModelImportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteTypeAnnotation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", + "traits": { + "smithy.api#documentation": "

The name of the custom type to delete from the policy. The type must not be referenced by any variables or rules.

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

Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker. For more information, see Import a customized model

", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/model-import-jobs" - }, - "smithy.api#idempotent": {} + "smithy.api#documentation": "

An annotation for removing a custom type from an Automated Reasoning policy.

" } }, - "com.amazonaws.bedrock#CreateModelImportJobRequest": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteTypeMutation": { "type": "structure", "members": { - "jobName": { - "target": "com.amazonaws.bedrock#JobName", + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", "traits": { - "smithy.api#documentation": "

The name of the import job.

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

The name of the custom type to delete.

", "smithy.api#required": {} } - }, - "importedModelName": { - "target": "com.amazonaws.bedrock#ImportedModelName", + } + }, + "traits": { + "smithy.api#documentation": "

A mutation operation that removes a custom type from the policy definition during the build process.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteTypeValue": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName", "traits": { - "smithy.api#documentation": "

The name of the imported model.

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

The identifier or name of the value to remove from the type.

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

Represents a value to be removed from an existing custom type in the policy.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteVariableAnnotation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model import job.

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

The name of the variable to delete from the policy. The variable must not be referenced by any rules.

", "smithy.api#required": {} } - }, - "modelDataSource": { - "target": "com.amazonaws.bedrock#ModelDataSource", + } + }, + "traits": { + "smithy.api#documentation": "

An annotation for removing a variable from an Automated Reasoning policy.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteVariableMutation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName", "traits": { - "smithy.api#documentation": "

The data source for the imported model.

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

The name of the variable to delete.

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

Tags to attach to this import job.

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

Tags to attach to the imported model.

" - } - }, - "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" - } - }, - "vpcConfig": { - "target": "com.amazonaws.bedrock#VpcConfig", - "traits": { - "smithy.api#documentation": "

VPC configuration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for the import job.

" - } - }, - "importedModelKmsKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The imported model is encrypted at rest using this key.

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

A mutation operation that removes a variable from the policy definition during the build process.

" } }, - "com.amazonaws.bedrock#CreateModelImportJobResponse": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDisjointRuleSet": { "type": "structure", "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelImportJobArn", + "variables": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableNameList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model import job.

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

The set of variables that are used by the rules in this disjoint set.

", + "smithy.api#required": {} + } + }, + "rules": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDisjointedRuleIdList", + "traits": { + "smithy.api#documentation": "

The list of rules that form this disjoint set, all operating on the same set of variables.

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

Represents a set of rules that operate on completely separate variables, indicating they address different concerns or domains within the policy.

" } }, - "com.amazonaws.bedrock#CreateModelInvocationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateModelInvocationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateModelInvocationJobResponse" + "com.amazonaws.bedrock#AutomatedReasoningPolicyDisjointRuleSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDisjointRuleSet" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyDisjointedRuleIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId" }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 } - ], + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyFormatVersion": { + "type": "string" + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyHash": { + "type": "string", "traits": { - "smithy.api#documentation": "

Creates a batch inference job to invoke a model on multiple prompts. Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Process multiple prompts with batch inference.

The response returns a jobArn that you can use to stop or get details about the job.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/model-invocation-job" + "smithy.api#length": { + "min": 128, + "max": 128 }, - "smithy.api#idempotent": {} + "smithy.api#pattern": "^[0-9a-z]{128}$" } }, - "com.amazonaws.bedrock#CreateModelInvocationJobRequest": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyIngestContentAnnotation": { "type": "structure", "members": { - "jobName": { - "target": "com.amazonaws.bedrock#ModelInvocationJobName", + "content": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationIngestContent", "traits": { - "smithy.api#documentation": "

A name to give the batch inference job.

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

The new content to be analyzed and incorporated into the policy, such as additional documents or rule descriptions.

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

An annotation for processing and incorporating new content into an Automated Reasoning policy.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyMutation": { + "type": "union", + "members": { + "addType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddTypeMutation", + "traits": { + "smithy.api#documentation": "

A mutation to add a new custom type to the policy.

" + } }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", + "updateType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateTypeMutation", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

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

A mutation to modify an existing custom type in the policy.

" } }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", + "deleteType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteTypeMutation", "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

A mutation to remove a custom type from the policy.

" } }, - "modelId": { - "target": "com.amazonaws.bedrock#ModelId", + "addVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddVariableMutation", "traits": { - "smithy.api#documentation": "

The unique identifier of the foundation model to use for the batch inference job.

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

A mutation to add a new variable to the policy.

" } }, - "inputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", + "updateVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateVariableMutation", "traits": { - "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

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

A mutation to modify an existing variable in the policy.

" } }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", + "deleteVariable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteVariableMutation", "traits": { - "smithy.api#documentation": "

Details about the location of the output of the batch inference job.

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

A mutation to remove a variable from the policy.

" } }, - "vpcConfig": { - "target": "com.amazonaws.bedrock#VpcConfig", + "addRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddRuleMutation", "traits": { - "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

" + "smithy.api#documentation": "

A mutation to add a new rule to the policy.

" } }, - "timeoutDurationInHours": { - "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", + "updateRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateRuleMutation", "traits": { - "smithy.api#documentation": "

The number of hours after which to force the batch inference job to time out.

" + "smithy.api#documentation": "

A mutation to modify an existing rule in the policy.

" } }, - "tags": { - "target": "com.amazonaws.bedrock#TagList", + "deleteRule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteRuleMutation", "traits": { - "smithy.api#documentation": "

Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

" + "smithy.api#documentation": "

A mutation to remove a rule from the policy.

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

A container for various mutation operations that can be applied to an Automated Reasoning policy, including adding, updating, and deleting policy elements.

" } }, - "com.amazonaws.bedrock#CreateModelInvocationJobResponse": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_ ]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyPlanning": { "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelInvocationJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

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

Represents the planning phase of policy build workflow, where the system analyzes source content and determines what operations to perform.

" } }, - "com.amazonaws.bedrock#CreatePromptRouter": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreatePromptRouterRequest" + "com.amazonaws.bedrock#AutomatedReasoningPolicyResource": { + "type": "resource", + "identifiers": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn" + } }, - "output": { - "target": "com.amazonaws.bedrock#CreatePromptRouterResponse" + "create": { + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicy" }, - "errors": [ + "read": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicy" + }, + "update": { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicy" + }, + "delete": { + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicy" + }, + "list": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicies" + }, + "operations": [ { - "target": "com.amazonaws.bedrock#AccessDeniedException" + "target": "com.amazonaws.bedrock#CancelAutomatedReasoningPolicyBuildWorkflow" }, { - "target": "com.amazonaws.bedrock#ConflictException" + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyTestCase" }, { - "target": "com.amazonaws.bedrock#InternalServerException" + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyVersion" }, { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyBuildWorkflow" }, { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyTestCase" }, { - "target": "com.amazonaws.bedrock#ThrottlingException" + "target": "com.amazonaws.bedrock#ExportAutomatedReasoningPolicyVersion" }, { - "target": "com.amazonaws.bedrock#TooManyTagsException" + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyAnnotations" }, { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/prompt-routers" + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflow" }, - "smithy.api#idempotent": {} - } + { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResultAssets" + }, + { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyNextScenario" + }, + { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestCase" + }, + { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestResult" + }, + { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyBuildWorkflows" + }, + { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestCases" + }, + { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestResults" + }, + { + "target": "com.amazonaws.bedrock#StartAutomatedReasoningPolicyBuildWorkflow" + }, + { + "target": "com.amazonaws.bedrock#StartAutomatedReasoningPolicyTestWorkflow" + }, + { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyAnnotations" + }, + { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyTestCase" + } + ] }, - "com.amazonaws.bedrock#CreatePromptRouterRequest": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyScenario": { "type": "structure", "members": { - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", + "expression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarioExpression", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure idempotency of your requests. If not specified, the Amazon Web Services SDK automatically generates one for you.

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

The logical expression or condition that defines this test scenario.

", + "smithy.api#required": {} } }, - "promptRouterName": { - "target": "com.amazonaws.bedrock#PromptRouterName", + "alternateExpression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarioAlternateExpression", "traits": { - "smithy.api#documentation": "

The name of the prompt router. The name must be unique within your Amazon Web Services account in the current region.

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

An alternative way to express the same test scenario, used for validation and comparison purposes.

", "smithy.api#required": {} } }, - "models": { - "target": "com.amazonaws.bedrock#PromptRouterTargetModels", + "ruleIds": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleIdList", "traits": { - "smithy.api#documentation": "

A list of foundation models that the prompt router can route requests to. At least one model must be specified.

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

The list of rule identifiers that are expected to be triggered or evaluated by this test scenario.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.bedrock#PromptRouterDescription", + "expectedResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckResult", "traits": { - "smithy.api#documentation": "

An optional description of the prompt router to help identify its purpose.

" + "smithy.api#documentation": "

The expected outcome when this scenario is evaluated against the policy (e.g., PASS, FAIL, VIOLATION).

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

Represents a test scenario used to validate an Automated Reasoning policy, including the test conditions and expected outcomes.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarioAlternateExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 }, - "routingCriteria": { - "target": "com.amazonaws.bedrock#RoutingCriteria", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarioExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicySummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicySummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicySummary": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

The criteria, which is the response quality difference, used to determine how incoming requests are routed to different models.

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

The Amazon Resource Name (ARN) of the policy.

", "smithy.api#required": {} } }, - "fallbackModel": { - "target": "com.amazonaws.bedrock#PromptRouterTargetModel", + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", "traits": { - "smithy.api#documentation": "

The default model to use when the routing criteria is not met.

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

The name of the policy.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.bedrock#TagList", + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription", "traits": { - "smithy.api#documentation": "

An array of key-value pairs to apply to this resource as tags. You can use tags to categorize and manage your Amazon Web Services resources.

" + "smithy.api#documentation": "

The description of the policy.

" } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#CreatePromptRouterResponse": { - "type": "structure", - "members": { - "promptRouterArn": { - "target": "com.amazonaws.bedrock#PromptRouterArn", + }, + "version": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyVersion", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the prompt router.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#CreateProvisionedModelThroughput": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/provisioned-model-throughput" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest": { - "type": "structure", - "members": { - "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

", - "smithy.api#idempotencyToken": {} - } - }, - "modelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", - "traits": { - "smithy.api#documentation": "

Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the Amazon Web Services support center to request MUs.

For model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide.

For more information about what an MU specifies, contact your Amazon Web Services account manager.

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

The version of the policy.

", "smithy.api#required": {} } }, - "provisionedModelName": { - "target": "com.amazonaws.bedrock#ProvisionedModelName", + "policyId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyId", "traits": { - "smithy.api#documentation": "

The name for this Provisioned Throughput.

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

The unique identifier of the policy.

", "smithy.api#required": {} } }, - "modelId": { - "target": "com.amazonaws.bedrock#ModelIdentifier", + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned Throughput in the Amazon Bedrock User Guide.

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

The timestamp when the policy was created.

", "smithy.api#required": {} } }, - "commitmentDuration": { - "target": "com.amazonaws.bedrock#CommitmentDuration", - "traits": { - "smithy.api#documentation": "

The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.

Custom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide

" - } - }, - "tags": { - "target": "com.amazonaws.bedrock#TagList", + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

Tags to associate with this Provisioned Throughput.

" + "smithy.api#documentation": "

The timestamp when the policy was last updated.

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

Contains summary information about an Automated Reasoning policy, including metadata and timestamps.

" } }, - "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCase": { "type": "structure", "members": { - "provisionedModelArn": { - "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "testCaseId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for this Provisioned Throughput.

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

The unique identifier of the test.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModel": { - "type": "structure", - "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#EvaluatorModelIdentifier", + }, + "guardContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestGuardContent", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the evaluator model for custom metrics. For a list of supported evaluator models, see Evaluate model performance using another LLM as a judge and Evaluate the performance of RAG sources using Amazon Bedrock evaluations.

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

The output content to be validated by the policy, typically representing a foundation model response.

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

Defines the model you want to evaluate custom metrics in an Amazon Bedrock evaluation job.

" - } - }, - "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModels": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModel" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.bedrock#CustomMetricDefinition": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrock#MetricName", + }, + "queryContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestQueryContent", "traits": { - "smithy.api#documentation": "

The name for a custom metric. Names must be unique in your Amazon Web Services region.

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

The input query or prompt that generated the content. This provides context for the validation.

" + } + }, + "expectedAggregatedFindingsResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckResult", + "traits": { + "smithy.api#documentation": "

The expected result of the Automated Reasoning check for this test.

" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the test was created.

", "smithy.api#required": {} } }, - "instructions": { - "target": "com.amazonaws.bedrock#CustomMetricInstructions", + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The prompt for a custom metric that instructs the evaluator model how to rate the model or RAG source under evaluation.

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

The timestamp when the test was last updated.

", "smithy.api#required": {} } }, - "ratingScale": { - "target": "com.amazonaws.bedrock#RatingScale", + "confidenceThreshold": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationConfidence", "traits": { - "smithy.api#documentation": "

Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see Specifying an output schema (rating scale).

" + "smithy.api#documentation": "

The minimum confidence level for logic validation. Content meeting this threshold is considered high-confidence and can be validated.

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

The definition of a custom metric for use in an Amazon Bedrock evaluation job. A custom metric definition includes a metric name, prompt (instructions) and optionally, a rating scale. Your prompt must include a task description and input variables. The required input variables are different for model-as-a-judge and RAG evaluations.

For more information about how to define a custom metric in Amazon Bedrock, see Create a prompt for a custom metrics (LLM-as-a-judge model evaluations) and Create a prompt for a custom metrics (RAG evaluations).

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

Represents a test for validating an Automated Reasoning policy. tests contain sample inputs and expected outcomes to verify policy behavior.

" } }, - "com.amazonaws.bedrock#CustomMetricEvaluatorModelConfig": { - "type": "structure", - "members": { - "bedrockEvaluatorModels": { - "target": "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModels", - "traits": { - "smithy.api#documentation": "

Defines the model you want to evaluate custom metrics in an Amazon Bedrock evaluation job.

", - "smithy.api#required": {} - } - } - }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId": { + "type": "string", "traits": { - "smithy.api#documentation": "

Configuration of the evaluator model you want to use to evaluate custom metrics in an Amazon Bedrock evaluation job.

" + "smithy.api#length": { + "max": 12 + }, + "smithy.api#pattern": "^[0-9A-Z]{12}$" } }, - "com.amazonaws.bedrock#CustomMetricInstructions": { - "type": "string", + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId" + }, "traits": { "smithy.api#length": { "min": 1, - "max": 5000 + "max": 1 } } }, - "com.amazonaws.bedrock#CustomModelArn": { - "type": "string", + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCase" + }, "traits": { "smithy.api#length": { - "min": 20, - "max": 1011 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}$" + "min": 0, + "max": 1000 + } } }, - "com.amazonaws.bedrock#CustomModelDeploymentArn": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestGuardContent": { "type": "string", "traits": { "smithy.api#length": { - "max": 1011 + "max": 1024 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12}$" + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrock#CustomModelDeploymentDescription": { - "type": "string", + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestResult" + }, "traits": { "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^.*$" + "min": 0, + "max": 5000 + } } }, - "com.amazonaws.bedrock#CustomModelDeploymentIdentifier": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestQueryContent": { "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 93 + "max": 1024 }, - "smithy.api#pattern": "^(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12})|^([0-9a-zA-Z][_-]?){1,63}$" + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrock#CustomModelDeploymentResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateCustomModelDeployment" - }, - { - "target": "com.amazonaws.bedrock#DeleteCustomModelDeployment" - }, - { - "target": "com.amazonaws.bedrock#GetCustomModelDeployment" - }, - { - "target": "com.amazonaws.bedrock#ListCustomModelDeployments" - } - ] - }, - "com.amazonaws.bedrock#CustomModelDeploymentStatus": { - "type": "enum", + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestResult": { + "type": "structure", "members": { - "CREATING": { - "target": "smithy.api#Unit", + "testCase": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCase", "traits": { - "smithy.api#enumValue": "Creating" + "smithy.api#required": {} } }, - "ACTIVE": { - "target": "smithy.api#Unit", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#enumValue": "Active" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy that was tested.

", + "smithy.api#required": {} } }, - "FAILED": { - "target": "smithy.api#Unit", + "testRunStatus": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestRunStatus", "traits": { - "smithy.api#enumValue": "Failed" + "smithy.api#documentation": "

The overall status of the test run (e.g., COMPLETED, FAILED, IN_PROGRESS).

", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.bedrock#CustomModelDeploymentSummary": { - "type": "structure", - "members": { - "customModelDeploymentArn": { - "target": "com.amazonaws.bedrock#CustomModelDeploymentArn", + }, + "testFindings": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckFindingList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model deployment.

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

Detailed findings from the test run, including any issues, violations, or unexpected behaviors discovered.

" } }, - "customModelDeploymentName": { - "target": "com.amazonaws.bedrock#ModelDeploymentName", + "testRunResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestRunResult", "traits": { - "smithy.api#documentation": "

The name of the custom model deployment.

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

The overall result of the test run, indicating whether the policy passed or failed validation.

" } }, - "modelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + "aggregatedTestFindingsResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckResult", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model associated with this deployment.

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

A summary of all test findings, aggregated to provide an overall assessment of policy quality and correctness.

" } }, - "createdAt": { + "updatedAt": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time when the custom model deployment was created.

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

The timestamp when the test results were last updated.

", "smithy.api#required": {} } - }, - "status": { - "target": "com.amazonaws.bedrock#CustomModelDeploymentStatus", + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of testing an Automated Reasoning policy against various scenarios and validation checks.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestRunResult": { + "type": "enum", + "members": { + "PASSED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The status of the custom model deployment. Possible values are CREATING, ACTIVE, and FAILED.

", - "smithy.api#required": {} + "smithy.api#enumValue": "PASSED" } }, - "lastUpdatedAt": { - "target": "com.amazonaws.bedrock#Timestamp", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The date and time when the custom model deployment was last modified.

" + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyTestRunStatus": { + "type": "enum", + "members": { + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_STARTED" } }, - "failureMessage": { - "target": "com.amazonaws.bedrock#ErrorMessage", + "SCHEDULED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

If the deployment status is FAILED, this field contains a message describing the failure reason.

" + "smithy.api#enumValue": "SCHEDULED" + } + }, + "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.bedrock#AutomatedReasoningPolicyTypeValueAnnotation": { + "type": "union", + "members": { + "addTypeValue": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAddTypeValue", + "traits": { + "smithy.api#documentation": "

An operation to add a new value to an existing custom type.

" + } + }, + "updateTypeValue": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateTypeValue", + "traits": { + "smithy.api#documentation": "

An operation to modify an existing value within a custom type.

" + } + }, + "deleteTypeValue": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDeleteTypeValue", + "traits": { + "smithy.api#documentation": "

An operation to remove a value from an existing custom type.

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

Contains summary information about a custom model deployment, including its ARN, name, status, and associated custom model.

" + "smithy.api#documentation": "

An annotation for managing values within custom types, including adding, updating, or removing specific type values.

" } }, - "com.amazonaws.bedrock#CustomModelDeploymentSummaryList": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyTypeValueAnnotationList": { "type": "list", "member": { - "target": "com.amazonaws.bedrock#CustomModelDeploymentSummary" - } - }, - "com.amazonaws.bedrock#CustomModelName": { - "type": "string", + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTypeValueAnnotation" + }, "traits": { "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,63}$" + "min": 0, + "max": 50 + } } }, - "com.amazonaws.bedrock#CustomModelResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateCustomModel" - }, - { - "target": "com.amazonaws.bedrock#DeleteCustomModel" - }, - { - "target": "com.amazonaws.bedrock#GetCustomModel" + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation": { + "type": "structure", + "members": { + "ruleIds": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleIdList", + "traits": { + "smithy.api#documentation": "

The list of rule identifiers that the feedback applies to.

" + } }, - { - "target": "com.amazonaws.bedrock#ListCustomModels" + "feedback": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationFeedbackNaturalLanguage", + "traits": { + "smithy.api#documentation": "

The feedback information about rule performance, including suggestions for improvements or corrections.

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

An annotation for updating the policy based on feedback about how specific rules performed during testing or real-world usage.

" + } }, - "com.amazonaws.bedrock#CustomModelSummary": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation": { "type": "structure", "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", + "ruleIds": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleIdList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model.

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

The list of rule identifiers that were involved in the scenario being evaluated.

" } }, - "modelName": { - "target": "com.amazonaws.bedrock#CustomModelName", + "scenarioExpression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyScenarioExpression", "traits": { - "smithy.api#documentation": "

The name of the custom model.

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

The logical expression that defines the test scenario that generated this feedback.

", "smithy.api#required": {} } }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "feedback": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationFeedbackNaturalLanguage", "traits": { - "smithy.api#documentation": "

Creation time of the model.

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

The feedback information about scenario performance, including any issues or improvements identified.

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

An annotation for updating the policy based on feedback about how it performed on specific test scenarios.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateRuleAnnotation": { + "type": "structure", + "members": { + "ruleId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the rule to update.

", "smithy.api#required": {} } }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + "expression": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRuleExpression", "traits": { - "smithy.api#documentation": "

The base model Amazon Resource Name (ARN).

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

The new formal logical expression for the rule, replacing the previous expression.

", "smithy.api#required": {} } - }, - "baseModelName": { - "target": "com.amazonaws.bedrock#ModelName", + } + }, + "traits": { + "smithy.api#documentation": "

An annotation for modifying an existing rule in an Automated Reasoning policy.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateRuleMutation": { + "type": "structure", + "members": { + "rule": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionRule", "traits": { - "smithy.api#documentation": "

The base model name.

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

A mutation operation that modifies an existing rule in the policy definition during the build process.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateTypeAnnotation": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", + "traits": { + "smithy.api#documentation": "

The current name of the custom type to update.

", "smithy.api#required": {} } }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", + "newName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeName", "traits": { - "smithy.api#documentation": "

Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

" + "smithy.api#documentation": "

The new name for the custom type, if you want to rename it. If not provided, the name remains unchanged.

" } }, - "ownerAccountId": { - "target": "com.amazonaws.bedrock#AccountId", + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeDescription", "traits": { - "smithy.api#documentation": "

The unique identifier of the account that owns the model.

" + "smithy.api#documentation": "

The new description for the custom type, replacing the previous description.

" } }, - "modelStatus": { - "target": "com.amazonaws.bedrock#ModelStatus", + "values": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTypeValueAnnotationList", "traits": { - "smithy.api#documentation": "

The current status of the custom model. Possible values include:

  • Creating - The model is being created and validated.

  • Active - The model has been successfully created and is ready for use.

  • Failed - The model creation process failed.

" + "smithy.api#documentation": "

The updated list of values for the custom type, which can include additions, modifications, or removals.

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

Summary information for a custom model.

" - } - }, - "com.amazonaws.bedrock#CustomModelSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#CustomModelSummary" + "smithy.api#documentation": "

An annotation for modifying an existing custom type in an Automated Reasoning policy.

" } }, - "com.amazonaws.bedrock#CustomModelUnits": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateTypeMutation": { "type": "structure", "members": { - "customModelUnitsPerModelCopy": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The number of custom model units used to host a model copy.

" - } - }, - "customModelUnitsVersion": { - "target": "com.amazonaws.bedrock#CustomModelUnitsVersion", + "type": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionType", "traits": { - "smithy.api#documentation": "

The version of the custom model unit. Use to determine the billing rate for the custom model unit.

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

A CustomModelUnit (CMU) is an abstract view of the hardware utilization that Amazon Bedrock needs to host a single copy of your custom model. A model copy represents a single instance of your imported model that is ready to serve inference requests. Amazon Bedrock determines the number of custom model units that a model copy needs when you import the custom model.

You can use CustomModelUnits to estimate the cost of running your custom model. For more information, see Calculate the cost of running a custom model in the Amazon Bedrock user guide.

" - } - }, - "com.amazonaws.bedrock#CustomModelUnitsVersion": { - "type": "string", - "traits": { - "smithy.api#pattern": "^v\\d+.\\d+$" + "smithy.api#documentation": "

A mutation operation that modifies an existing custom type in the policy definition during the build process.

" } }, - "com.amazonaws.bedrock#CustomizationConfig": { - "type": "union", + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateTypeValue": { + "type": "structure", "members": { - "distillationConfig": { - "target": "com.amazonaws.bedrock#DistillationConfig", + "value": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName", "traits": { - "smithy.api#documentation": "

The Distillation configuration for the custom model.

" + "smithy.api#documentation": "

The current identifier or name of the type value to update.

", + "smithy.api#required": {} + } + }, + "newValue": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueName", + "traits": { + "smithy.api#documentation": "

The new identifier or name for the type value, if you want to rename it.

" + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionTypeValueDescription", + "traits": { + "smithy.api#documentation": "

The new description for the type value, replacing the previous description.

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

A model customization configuration

" + "smithy.api#documentation": "

Represents a modification to a value within an existing custom type.

" } }, - "com.amazonaws.bedrock#CustomizationType": { - "type": "enum", + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateVariableAnnotation": { + "type": "structure", "members": { - "FINE_TUNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FINE_TUNING" - } - }, - "CONTINUED_PRE_TRAINING": { - "target": "smithy.api#Unit", + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName", "traits": { - "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" + "smithy.api#documentation": "

The current name of the variable to update.

", + "smithy.api#required": {} } }, - "DISTILLATION": { - "target": "smithy.api#Unit", + "newName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableName", "traits": { - "smithy.api#enumValue": "DISTILLATION" + "smithy.api#documentation": "

The new name for the variable, if you want to rename it. If not provided, the name remains unchanged.

" } }, - "IMPORTED": { - "target": "smithy.api#Unit", + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariableDescription", "traits": { - "smithy.api#enumValue": "IMPORTED" + "smithy.api#documentation": "

The new description for the variable, replacing the previous description.

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

An annotation for modifying an existing variable in an Automated Reasoning policy.

" } }, - "com.amazonaws.bedrock#DataProcessingDetails": { + "com.amazonaws.bedrock#AutomatedReasoningPolicyUpdateVariableMutation": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.bedrock#JobStatusDetails", + "variable": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinitionVariable", "traits": { - "smithy.api#documentation": "

The status of the data processing sub-task of the job.

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

A mutation operation that modifies an existing variable in the policy definition during the build process.

" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 12 }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "smithy.api#pattern": "^([1-9][0-9]{0,11})$" + } + }, + "com.amazonaws.bedrock#AutomatedReasoningPolicyWorkflowTypeContent": { + "type": "union", + "members": { + "documents": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowDocumentList", "traits": { - "smithy.api#documentation": "

The start time of the data processing sub-task of the job.

" + "smithy.api#documentation": "

The list of documents to be processed in a document ingestion workflow.

" } }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "policyRepairAssets": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowRepairContent", "traits": { - "smithy.api#documentation": "

The latest update to the data processing sub-task of the job.

" + "smithy.api#documentation": "

The assets and instructions needed for a policy repair workflow, including repair annotations and guidance.

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

For a Distillation job, the status details for the data processing sub-task of the job.

" + "smithy.api#documentation": "

Defines the content and configuration for different types of policy build workflows.

" } }, - "com.amazonaws.bedrock#DeleteCustomModel": { + "com.amazonaws.bedrock#BaseModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "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})([:][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}){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][_-]?)+)$" + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJob": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#DeleteCustomModelRequest" + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobRequest" }, "output": { - "target": "com.amazonaws.bedrock#DeleteCustomModelResponse" + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobResponse" }, "errors": [ { @@ -3446,84 +3741,116 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.

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

Deletes a batch of evaluation jobs. An evaluation job can only be deleted if it has following status FAILED, COMPLETED, and STOPPED. You can request up to 25 model evaluation jobs be deleted in a single request.

", + "smithy.api#examples": [ + { + "title": "Delete evaluation jobs", + "documentation": "The following example shows a request to delete two model evaluation jobs, where one of the jobs is not found.", + "input": { + "jobIdentifiers": [ + "arn:aws:bedrock:us-east-2:123456789012:evaluation-job/12rnxmplqv0v", + "arn:aws:bedrock:us-east-2:123456789012:evaluation-job/rispxmpl12rn" + ] + }, + "output": { + "evaluationJobs": [ + { + "jobIdentifier": "arn:aws:bedrock:us-east-2:123456789012:evaluation-job/12rnxmplqv0v", + "jobStatus": "Deleting" + } + ], + "errors": [ + { + "message": "Unable to locate this job to delete.", + "code": "404", + "jobIdentifier": "arn:aws:bedrock:us-east-2:123456789012:evaluation-job/rispxmpl12rn" + } + ] + } + } + ], "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/custom-models/{modelIdentifier}" - }, - "smithy.api#idempotent": {} + "code": 202, + "method": "POST", + "uri": "/evaluation-jobs/batch-delete" + } } }, - "com.amazonaws.bedrock#DeleteCustomModelDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#DeleteCustomModelDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#DeleteCustomModelDeploymentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" + "com.amazonaws.bedrock#BatchDeleteEvaluationJobError": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the evaluation job being deleted.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A HTTP status code of the evaluation job being deleted.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ValidationException" + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A status message about the evaluation job deletion.

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

Deletes a custom model deployment. This operation stops the deployment and removes it from your account. After deletion, the deployment ARN can no longer be used for inference requests.

The following actions are related to the DeleteCustomModelDeployment operation:

", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/model-customization/custom-model-deployments/{customModelDeploymentIdentifier}" - }, - "smithy.api#idempotent": {} + "smithy.api#documentation": "

A JSON array that provides the status of the evaluation jobs being deleted.

" } }, - "com.amazonaws.bedrock#DeleteCustomModelDeploymentRequest": { + "com.amazonaws.bedrock#BatchDeleteEvaluationJobErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobError" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJobItem": { "type": "structure", "members": { - "customModelDeploymentIdentifier": { - "target": "com.amazonaws.bedrock#CustomModelDeploymentIdentifier", + "jobIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the custom model deployment to delete.

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

The Amazon Resource Name (ARN) of the evaluation job for deletion.

", + "smithy.api#required": {} + } + }, + "jobStatus": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the evaluation job for deletion.

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

An evaluation job for deletion, and it’s current status.

" } }, - "com.amazonaws.bedrock#DeleteCustomModelDeploymentResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} + "com.amazonaws.bedrock#BatchDeleteEvaluationJobItems": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobItem" } }, - "com.amazonaws.bedrock#DeleteCustomModelRequest": { + "com.amazonaws.bedrock#BatchDeleteEvaluationJobRequest": { "type": "structure", "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#ModelIdentifier", + "jobIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifiers", "traits": { - "smithy.api#documentation": "

Name of the model to delete.

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

A list of one or more evaluation job Amazon Resource Names (ARNs) you want to delete.

", "smithy.api#required": {} } } @@ -3532,155 +3859,180 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#DeleteCustomModelResponse": { + "com.amazonaws.bedrock#BatchDeleteEvaluationJobResponse": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#DeleteFoundationModelAgreement": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#DeleteFoundationModelAgreementRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#DeleteFoundationModelAgreementResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" + "members": { + "errors": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobErrors", + "traits": { + "smithy.api#documentation": "

A JSON object containing the HTTP status codes and the ARNs of evaluation jobs that failed to be deleted.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ValidationException" + "evaluationJobs": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobItems", + "traits": { + "smithy.api#documentation": "

The list of evaluation jobs for deletion.

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

Delete the model access agreement for the specified model.

", - "smithy.api#http": { - "code": 202, - "method": "POST", - "uri": "/delete-foundation-model-agreement" - } + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#DeleteFoundationModelAgreementRequest": { + "com.amazonaws.bedrock#BedrockEvaluatorModel": { "type": "structure", "members": { - "modelId": { - "target": "com.amazonaws.bedrock#BedrockModelId", + "modelIdentifier": { + "target": "com.amazonaws.bedrock#EvaluatorModelIdentifier", "traits": { - "smithy.api#documentation": "

Model Id of the model access to delete.

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

The Amazon Resource Name (ARN) of the evaluator model used used in knowledge base evaluation job or in model evaluation job that use a model as judge.

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

The evaluator model used in knowledge base evaluation job or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

" } }, - "com.amazonaws.bedrock#DeleteFoundationModelAgreementResponse": { - "type": "structure", - "members": {}, + "com.amazonaws.bedrock#BedrockEvaluatorModels": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#BedrockEvaluatorModel" + }, "traits": { - "smithy.api#output": {} + "smithy.api#length": { + "min": 1, + "max": 1 + } } }, - "com.amazonaws.bedrock#DeleteGuardrail": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#DeleteGuardrailRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#DeleteGuardrailResponse" - }, - "errors": [ + "com.amazonaws.bedrock#BedrockMarketplaceResource": { + "type": "resource", + "operations": [ { - "target": "com.amazonaws.bedrock#AccessDeniedException" + "target": "com.amazonaws.bedrock#CreateMarketplaceModelEndpoint" }, { - "target": "com.amazonaws.bedrock#ConflictException" + "target": "com.amazonaws.bedrock#DeleteMarketplaceModelEndpoint" }, { - "target": "com.amazonaws.bedrock#InternalServerException" + "target": "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpoint" }, { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" + "target": "com.amazonaws.bedrock#GetMarketplaceModelEndpoint" }, { - "target": "com.amazonaws.bedrock#ThrottlingException" + "target": "com.amazonaws.bedrock#ListMarketplaceModelEndpoints" }, { - "target": "com.amazonaws.bedrock#ValidationException" + "target": "com.amazonaws.bedrock#RegisterMarketplaceModelEndpoint" + }, + { + "target": "com.amazonaws.bedrock#UpdateMarketplaceModelEndpoint" } - ], + ] + }, + "com.amazonaws.bedrock#BedrockModelArn": { + "type": "string", "traits": { - "smithy.api#documentation": "

Deletes a guardrail.

  • To delete a guardrail, only specify the ARN of the guardrail in the guardrailIdentifier field. If you delete a guardrail, all of its versions will be deleted.

  • To delete a version of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field and the version in the guardrailVersion field.

", - "smithy.api#http": { - "code": 202, - "method": "DELETE", - "uri": "/guardrails/{guardrailIdentifier}" + "smithy.api#length": { + "min": 1, + "max": 2048 }, - "smithy.api#idempotent": {} + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" } }, - "com.amazonaws.bedrock#DeleteGuardrailRequest": { + "com.amazonaws.bedrock#BedrockModelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 140 + }, + "smithy.api#pattern": "^[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)$" + } + }, + "com.amazonaws.bedrock#BedrockRerankingModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$" + } + }, + "com.amazonaws.bedrock#BrandedName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrock#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + } + } + }, + "com.amazonaws.bedrock#ByteContentBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10485760 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#ByteContentDoc": { "type": "structure", "members": { - "guardrailIdentifier": { - "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "identifier": { + "target": "com.amazonaws.bedrock#Identifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

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

The file name of the document contained in the wrapper object.

", "smithy.api#required": {} } }, - "guardrailVersion": { - "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", + "contentType": { + "target": "com.amazonaws.bedrock#ContentType", "traits": { - "smithy.api#documentation": "

The version of the guardrail.

", - "smithy.api#httpQuery": "guardrailVersion" + "smithy.api#documentation": "

The MIME type of the document contained in the wrapper object.

", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.bedrock#ByteContentBlob", + "traits": { + "smithy.api#documentation": "

The byte value of the file to upload, encoded as a Base-64 string.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#DeleteGuardrailResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Contains the document contained in the wrapper object, along with its attributes/fields.

" } }, - "com.amazonaws.bedrock#DeleteImportedModel": { + "com.amazonaws.bedrock#CancelAutomatedReasoningPolicyBuildWorkflow": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#DeleteImportedModelRequest" + "target": "com.amazonaws.bedrock#CancelAutomatedReasoningPolicyBuildWorkflowRequest" }, "output": { - "target": "com.amazonaws.bedrock#DeleteImportedModelResponse" + "target": "com.amazonaws.bedrock#CancelAutomatedReasoningPolicyBuildWorkflowResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, { "target": "com.amazonaws.bedrock#InternalServerException" }, @@ -3695,45 +4047,122 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.

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

Cancels a running Automated Reasoning policy build workflow. This stops the policy generation process and prevents further processing of the source documents.

", "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/imported-models/{modelIdentifier}" + "code": 202, + "method": "POST", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/cancel" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#DeleteImportedModelRequest": { + "com.amazonaws.bedrock#CancelAutomatedReasoningPolicyBuildWorkflowRequest": { "type": "structure", "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#ImportedModelIdentifier", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

Name of the imported model to delete.

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

The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow you want to cancel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the build workflow to cancel. You can get this ID from the StartAutomatedReasoningPolicyBuildWorkflow response or by listing build workflows.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#input": {} + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] } }, - "com.amazonaws.bedrock#DeleteImportedModelResponse": { + "com.amazonaws.bedrock#CancelAutomatedReasoningPolicyBuildWorkflowResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#DeleteInferenceProfile": { + "com.amazonaws.bedrock#CloudWatchConfig": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.bedrock#LogGroupName", + "traits": { + "smithy.api#documentation": "

The log group name.

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

The role Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "largeDataDeliveryS3Config": { + "target": "com.amazonaws.bedrock#S3Config", + "traits": { + "smithy.api#documentation": "

S3 configuration for delivering a large amount of data.

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

CloudWatch logging configuration.

" + } + }, + "com.amazonaws.bedrock#CommitmentDuration": { + "type": "enum", + "members": { + "ONE_MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OneMonth" + } + }, + "SIX_MONTHS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SixMonths" + } + } + } + }, + "com.amazonaws.bedrock#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "

Error occurred because of a conflict while performing an operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrock#ContentType": { + "type": "string", + "traits": { + "smithy.api#pattern": "[a-z]{1,20}/.{1,20}" + } + }, + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicy": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#DeleteInferenceProfileRequest" + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyRequest" }, "output": { - "target": "com.amazonaws.bedrock#DeleteInferenceProfileResponse" + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyResponse" }, "errors": [ { @@ -3748,64 +4177,148 @@ { "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.bedrock#ThrottlingException" }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, { "target": "com.amazonaws.bedrock#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Deletes an application inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

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

Creates an Automated Reasoning policy for Amazon Bedrock Guardrails. Automated Reasoning policies use mathematical techniques to detect hallucinations, suggest corrections, and highlight unstated assumptions in the responses of your GenAI application.

To create a policy, you upload a source document that describes the rules that you're encoding. Automated Reasoning extracts important concepts from the source document that will become variables in the policy and infers policy rules.

", "smithy.api#http": { "code": 200, - "method": "DELETE", - "uri": "/inference-profiles/{inferenceProfileIdentifier}" + "method": "POST", + "uri": "/automated-reasoning-policies" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#DeleteInferenceProfileRequest": { + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyRequest": { "type": "structure", "members": { - "inferenceProfileIdentifier": { - "target": "com.amazonaws.bedrock#InferenceProfileIdentifier", + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) or ID of the application inference profile to delete.

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

A unique name for the Automated Reasoning policy. The name must be between 1 and 63 characters and can contain letters, numbers, hyphens, and underscores.

", "smithy.api#required": {} } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription", + "traits": { + "smithy.api#documentation": "

A description of the Automated Reasoning policy. Use this to provide context about the policy's purpose and the types of validations it performs.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the operation completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error.

", + "smithy.api#idempotencyToken": {} + } + }, + "policyDefinition": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition", + "traits": { + "smithy.api#documentation": "

The policy definition that contains the formal logic rules, variables, and custom variable types used to validate foundation model responses in your application.

" + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to associate with the Automated Reasoning policy. Tags help you organize and manage your policies.

" + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.bedrock#DeleteInferenceProfileResponse": { + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyResponse": { "type": "structure", - "members": {}, + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy that you created.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version number of the newly created Automated Reasoning policy. The initial version is always DRAFT.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the Automated Reasoning policy.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription", + "traits": { + "smithy.api#documentation": "

The description of the Automated Reasoning policy.

" + } + }, + "definitionHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", + "traits": { + "smithy.api#documentation": "

The hash of the policy definition. This is used as a concurrency token for creating policy versions that you can use in your application.

" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the policy was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the policy was last updated.

", + "smithy.api#required": {} + } + } + }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#DeleteMarketplaceModelEndpoint": { + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyTestCase": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#DeleteMarketplaceModelEndpointRequest" + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyTestCaseRequest" }, "output": { - "target": "com.amazonaws.bedrock#DeleteMarketplaceModelEndpointResponse" + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyTestCaseResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, { - "target": "com.amazonaws.bedrock#InternalServerException" + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" }, { "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.bedrock#ThrottlingException" }, @@ -3814,99 +4327,110 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an endpoint for a model from Amazon Bedrock Marketplace.

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

Creates a test for an Automated Reasoning policy. Tests validate that your policy works as expected by providing sample inputs and expected outcomes. Use tests to verify policy behavior before deploying to production.

", "smithy.api#http": { "code": 200, - "method": "DELETE", - "uri": "/marketplace-model/endpoints/{endpointArn}" + "method": "POST", + "uri": "/automated-reasoning-policies/{policyArn}/test-cases" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#DeleteMarketplaceModelEndpointRequest": { + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyTestCaseRequest": { "type": "structure", "members": { - "endpointArn": { - "target": "com.amazonaws.bedrock#Arn", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint you want to delete.

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

The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to create the test.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "guardContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestGuardContent", + "traits": { + "smithy.api#documentation": "

The output content that's validated by the Automated Reasoning policy. This represents the foundation model response that will be checked for accuracy.

", + "smithy.api#required": {} + } + }, + "queryContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestQueryContent", + "traits": { + "smithy.api#documentation": "

The input query or prompt that generated the content. This provides context for the validation.

" + } + }, + "expectedAggregatedFindingsResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckResult", + "traits": { + "smithy.api#documentation": "

The expected result of the Automated Reasoning check. Valid values include: , TOO_COMPLEX, and NO_TRANSLATIONS.

  • VALID - The claims are true. The claims are implied by the premises and the Automated Reasoning policy. Given the Automated Reasoning policy and premises, it is not possible for these claims to be false. In other words, there are no alternative answers that are true that contradict the claims.

  • INVALID - The claims are false. The claims are not implied by the premises and Automated Reasoning policy. Furthermore, there exists different claims that are consistent with the premises and Automated Reasoning policy.

  • SATISFIABLE - The claims can be true or false. It depends on what assumptions are made for the claim to be implied from the premises and Automated Reasoning policy rules. In this situation, different assumptions can make input claims false and alternative claims true.

  • IMPOSSIBLE - Automated Reasoning can’t make a statement about the claims. This can happen if the premises are logically incorrect, or if there is a conflict within the Automated Reasoning policy itself.

  • TRANSLATION_AMBIGUOUS - Detected an ambiguity in the translation meant it would be unsound to continue with validity checking. Additional context or follow-up questions might be needed to get translation to succeed.

  • TOO_COMPLEX - The input contains too much information for Automated Reasoning to process within its latency limits.

  • NO_TRANSLATIONS - Identifies that some or all of the input prompt wasn't translated into logic. This can happen if the input isn't relevant to the Automated Reasoning policy, or if the policy doesn't have variables to model relevant input. If Automated Reasoning can't translate anything, you get a single NO_TRANSLATIONS finding. You might also see a NO_TRANSLATIONS (along with other findings) if some part of the validation isn't translated.

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.

", + "smithy.api#idempotencyToken": {} + } + }, + "confidenceThreshold": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationConfidence", + "traits": { + "smithy.api#documentation": "

The minimum confidence level for logic validation. Content that meets the threshold is considered a high-confidence finding that can be validated.

" + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.bedrock#DeleteMarketplaceModelEndpointResponse": { + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyTestCaseResponse": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy for which the test was created.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" + "testCaseId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the created test.

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

Delete the invocation logging.

", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/logging/modelinvocations" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse": { - "type": "structure", - "members": {}, + }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#DeletePromptRouter": { + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyVersion": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#DeletePromptRouterRequest" + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyVersionRequest" }, "output": { - "target": "com.amazonaws.bedrock#DeletePromptRouterResponse" + "target": "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyVersionResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, { "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.bedrock#ThrottlingException" }, @@ -3915,45 +4439,107 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a specified prompt router. This action cannot be undone.

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

Creates a new version of an existing Automated Reasoning policy. This allows you to iterate on your policy rules while maintaining previous versions for rollback or comparison purposes.

", "smithy.api#http": { "code": 200, - "method": "DELETE", - "uri": "/prompt-routers/{promptRouterArn}" + "method": "POST", + "uri": "/automated-reasoning-policies/{policyArn}/versions" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#DeletePromptRouterRequest": { + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyVersionRequest": { "type": "structure", "members": { - "promptRouterArn": { - "target": "com.amazonaws.bedrock#PromptRouterArn", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the prompt router to delete.

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

The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to create a version.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.

", + "smithy.api#idempotencyToken": {} + } + }, + "lastUpdatedDefinitionHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", + "traits": { + "smithy.api#documentation": "

The hash of the current policy definition used as a concurrency token to ensure the policy hasn't been modified since you last retrieved it.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to associate with the policy version.

" + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.bedrock#DeletePromptRouterResponse": { + "com.amazonaws.bedrock#CreateAutomatedReasoningPolicyVersionResponse": { "type": "structure", - "members": {}, + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The versioned Amazon Resource Name (ARN) of the policy version.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version number of the policy version.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the policy version.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription", + "traits": { + "smithy.api#documentation": "

The description of the policy version.

" + } + }, + "definitionHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", + "traits": { + "smithy.api#documentation": "

The hash of the policy definition for this version.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the policy version was created.

", + "smithy.api#required": {} + } + } + }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#DeleteProvisionedModelThroughput": { + "com.amazonaws.bedrock#CreateCustomModel": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest" + "target": "com.amazonaws.bedrock#CreateCustomModelRequest" }, "output": { - "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse" + "target": "com.amazonaws.bedrock#CreateCustomModelResponse" }, "errors": [ { @@ -3968,53 +4554,65 @@ { "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.bedrock#ThrottlingException" }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, { "target": "com.amazonaws.bedrock#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

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

Creates a new custom model in Amazon Bedrock. After the model is active, you can use it for inference.

To use the model for inference, you must purchase Provisioned Throughput for it. You can't use On-demand inference with these custom models. For more information about Provisioned Throughput, see Provisioned Throughput.

The model appears in ListCustomModels with a customizationType of imported. To track the status of the new model, you use the GetCustomModel API operation. The model can be in the following states:

  • Creating - Initial state during validation and registration

  • Active - Model is ready for use in inference

  • Failed - Creation process encountered an error

Related APIs

", + "smithy.api#examples": [ + { + "title": "Successful CreateCustomModel API call", + "input": { + "modelName": "SampleModel", + "modelSourceConfig": { + "s3DataSource": { + "s3Uri": "s3://my-bucket/folder" + } + }, + "roleArn": "arn:aws:iam::123456789012:role/SampleRole", + "modelKmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "modelTags": [ + { + "key": "foo", + "value": "foo" + }, + { + "key": "foo", + "value": "foo" + } + ], + "clientRequestToken": "foo" + }, + "output": { + "modelArn": "arn:aws:bedrock:us-east-1:123456789012:custom-model/imported/abcdef123456" + } + } + ], "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/provisioned-model-throughput/{provisionedModelId}" + "code": 202, + "method": "POST", + "uri": "/custom-models/create-custom-model" }, "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest": { - "type": "structure", - "members": { - "provisionedModelId": { - "target": "com.amazonaws.bedrock#ProvisionedModelId", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the Provisioned Throughput.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpoint": { + "com.amazonaws.bedrock#CreateCustomModelDeployment": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpointRequest" + "target": "com.amazonaws.bedrock#CreateCustomModelDeploymentRequest" }, "output": { - "target": "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpointResponse" + "target": "com.amazonaws.bedrock#CreateCustomModelDeploymentResponse" }, "errors": [ { @@ -4027,1514 +4625,1537 @@ "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, { - "target": "com.amazonaws.bedrock#ServiceUnavailableException" + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrock#ThrottlingException" }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, { "target": "com.amazonaws.bedrock#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Deregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint.

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

Deploys a custom model for on-demand inference in Amazon Bedrock. After you deploy your custom model, you use the deployment's Amazon Resource Name (ARN) as the modelId parameter when you submit prompts and generate responses with model inference.

For more information about setting up on-demand inference for custom models, see Set up inference for a custom model.

The following actions are related to the CreateCustomModelDeployment operation:

", "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/marketplace-model/endpoints/{endpointArn}/registration" - } + "code": 202, + "method": "POST", + "uri": "/model-customization/custom-model-deployments" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpointRequest": { + "com.amazonaws.bedrock#CreateCustomModelDeploymentRequest": { "type": "structure", "members": { - "endpointArn": { - "target": "com.amazonaws.bedrock#Arn", + "modelDeploymentName": { + "target": "com.amazonaws.bedrock#ModelDeploymentName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint you want to deregister.

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

The name for the custom model deployment. The name must be unique within your Amazon Web Services account and Region.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpointResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#DimensionalPriceRate": { - "type": "structure", - "members": { - "dimension": { - "target": "smithy.api#String", + }, + "modelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", "traits": { - "smithy.api#documentation": "

Dimension for the price rate.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model to deploy for on-demand inference. The custom model must be in the Active state.

", + "smithy.api#required": {} } }, - "price": { - "target": "smithy.api#String", + "description": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentDescription", "traits": { - "smithy.api#documentation": "

Single-dimensional rate information.

" + "smithy.api#documentation": "

A description for the custom model deployment to help you identify its purpose.

" } }, - "description": { - "target": "smithy.api#String", + "tags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "

Description of the price rate.

" + "smithy.api#documentation": "

Tags to assign to the custom model deployment. You can use tags to organize and track your Amazon Web Services resources for cost allocation and management purposes.

" } }, - "unit": { - "target": "smithy.api#String", + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Unit associated with the price.

" + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

Dimensional price rate.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#DistillationConfig": { + "com.amazonaws.bedrock#CreateCustomModelDeploymentResponse": { "type": "structure", "members": { - "teacherModelConfig": { - "target": "com.amazonaws.bedrock#TeacherModelConfig", + "customModelDeploymentArn": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentArn", "traits": { - "smithy.api#documentation": "

The teacher model configuration.

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

The Amazon Resource Name (ARN) of the custom model deployment. Use this ARN as the modelId parameter when invoking the model with the InvokeModel or Converse operations.

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

Settings for distilling a foundation model into a smaller and more efficient model.

" - } - }, - "com.amazonaws.bedrock#EndpointConfig": { - "type": "union", - "members": { - "sageMaker": { - "target": "com.amazonaws.bedrock#SageMakerEndpoint", - "traits": { - "smithy.api#documentation": "

The configuration specific to Amazon SageMaker for the endpoint.

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

Specifies the configuration for the endpoint.

" - } - }, - "com.amazonaws.bedrock#EndpointName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - } + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#EntitlementAvailability": { - "type": "enum", + "com.amazonaws.bedrock#CreateCustomModelRequest": { + "type": "structure", "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", + "modelName": { + "target": "com.amazonaws.bedrock#CustomModelName", "traits": { - "smithy.api#enumValue": "AVAILABLE" + "smithy.api#documentation": "

A unique name for the custom model.

", + "smithy.api#required": {} } }, - "NOT_AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_AVAILABLE" - } - } - } - }, - "com.amazonaws.bedrock#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - } - } - }, - "com.amazonaws.bedrock#ErrorMessages": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ErrorMessage" - }, - "traits": { - "smithy.api#length": { - "max": 20 - } - } - }, - "com.amazonaws.bedrock#EvaluationBedrockKnowledgeBaseIdentifiers": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#KnowledgeBaseId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.bedrock#EvaluationBedrockModel": { - "type": "structure", - "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#EvaluationBedrockModelIdentifier", + "modelSourceConfig": { + "target": "com.amazonaws.bedrock#ModelDataSource", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Bedrock model or inference profile specified.

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

The data source for the model. The Amazon S3 URI in the model source must be for the Amazon-managed Amazon S3 bucket containing your model artifacts.

", "smithy.api#required": {} } }, - "inferenceParams": { - "target": "com.amazonaws.bedrock#EvaluationModelInferenceParams", + "modelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", "traits": { - "smithy.api#addedDefault": {}, - "smithy.api#default": "{}", - "smithy.api#documentation": "

Each Amazon Bedrock support different inference parameters that change how the model behaves during inference.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer managed KMS key to encrypt the custom model. If you don't provide a KMS key, Amazon Bedrock uses an Amazon Web Services-managed KMS key to encrypt the model.

If you provide a customer managed KMS key, your Amazon Bedrock service role must have permissions to use it. For more information see Encryption of imported models.

" } }, - "performanceConfig": { - "target": "com.amazonaws.bedrock#PerformanceConfiguration", + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", "traits": { - "smithy.api#documentation": "

Specifies performance settings for the model or inference profile.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock assumes to perform tasks on your behalf. This role must have permissions to access the Amazon S3 bucket containing your model artifacts and the KMS key (if specified). For more information, see Setting up an IAM service role for importing models in the Amazon Bedrock User Guide.

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

Contains the ARN of the Amazon Bedrock model or inference profile specified in your 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.

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#EvaluationBedrockModelIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 }, - "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}:application-inference-profile/[a-z0-9]{12})|([0-9]{12}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([0-9]{12}:(default-prompt-router|prompt-router)/[a-zA-Z0-9-:.]+)))|(([a-z]{2,4}[.]{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}))|arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:endpoint/[a-z0-9-]{1,63}$" - } - }, - "com.amazonaws.bedrock#EvaluationBedrockModelIdentifiers": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationBedrockModelIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.bedrock#EvaluationConfig": { - "type": "union", - "members": { - "automated": { - "target": "com.amazonaws.bedrock#AutomatedEvaluationConfig", + "modelTags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "

Contains the configuration details of an automated evaluation job that computes metrics.

" + "smithy.api#documentation": "

A list of key-value pairs to associate with the custom model resource. You can use these tags to organize and identify your resources.

For more information, see Tagging resources in the Amazon Bedrock User Guide.

" } }, - "human": { - "target": "com.amazonaws.bedrock#HumanEvaluationConfig", + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Contains the configuration details of an evaluation job that uses human workers.

" + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

The configuration details of either an automated or human-based evaluation job.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#EvaluationDataset": { + "com.amazonaws.bedrock#CreateCustomModelResponse": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.bedrock#EvaluationDatasetName", + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", "traits": { - "smithy.api#documentation": "

Used to specify supported built-in prompt datasets. Valid values are Builtin.Bold, Builtin.BoolQ, Builtin.NaturalQuestions, Builtin.Gigaword, Builtin.RealToxicityPrompts, Builtin.TriviaQA, Builtin.T-Rex, Builtin.WomensEcommerceClothingReviews and Builtin.Wikitext2.

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

The Amazon Resource Name (ARN) of the new custom model.

", "smithy.api#required": {} } - }, - "datasetLocation": { - "target": "com.amazonaws.bedrock#EvaluationDatasetLocation", - "traits": { - "smithy.api#documentation": "

For custom prompt datasets, you must specify the location in Amazon S3 where the prompt dataset is saved.

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

Used to specify the name of a built-in prompt dataset and optionally, the Amazon S3 bucket where a custom prompt dataset is saved.

" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#EvaluationDatasetLocation": { - "type": "union", - "members": { - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", - "traits": { - "smithy.api#documentation": "

The S3 URI of the S3 bucket specified in the job.

" - } - } + "com.amazonaws.bedrock#CreateEvaluationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateEvaluationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateEvaluationJobResponse" }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where your prompt dataset is stored.

" + "smithy.api#documentation": "

Creates an evaluation job.

", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/evaluation-jobs" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#EvaluationDatasetMetricConfig": { + "com.amazonaws.bedrock#CreateEvaluationJobRequest": { "type": "structure", "members": { - "taskType": { - "target": "com.amazonaws.bedrock#EvaluationTaskType", + "jobName": { + "target": "com.amazonaws.bedrock#EvaluationJobName", "traits": { - "smithy.api#documentation": "

The the type of task you want to evaluate for your evaluation job. This applies only to model evaluation jobs and is ignored for knowledge base evaluation jobs.

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

A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account's Amazon Web Services region.

", "smithy.api#required": {} } }, - "dataset": { - "target": "com.amazonaws.bedrock#EvaluationDataset", + "jobDescription": { + "target": "com.amazonaws.bedrock#EvaluationJobDescription", "traits": { - "smithy.api#documentation": "

Specifies the prompt dataset.

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

A description of the evaluation job.

" + } + }, + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see Required permissions for model evaluations.

", "smithy.api#required": {} } }, - "metricNames": { - "target": "com.amazonaws.bedrock#EvaluationMetricNames", + "customerEncryptionKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", "traits": { - "smithy.api#documentation": "

The names of the metrics you want to use for your evaluation job.

For knowledge base evaluation jobs that evaluate retrieval only, valid values are \"Builtin.ContextRelevance\", \"Builtin.ContextCoverage\".

For knowledge base evaluation jobs that evaluate retrieval with response generation, valid values are \"Builtin.Correctness\", \"Builtin.Completeness\", \"Builtin.Helpfulness\", \"Builtin.LogicalCoherence\", \"Builtin.Faithfulness\", \"Builtin.Harmfulness\", \"Builtin.Stereotyping\", \"Builtin.Refusal\".

For automated model evaluation jobs, valid values are \"Builtin.Accuracy\", \"Builtin.Robustness\", and \"Builtin.Toxicity\". In model evaluation jobs that use a LLM as judge you can specify \"Builtin.Correctness\", \"Builtin.Completeness\", \"Builtin.Faithfulness\", \"Builtin.Helpfulness\", \"Builtin.Coherence\", \"Builtin.Relevance\", \"Builtin.FollowingInstructions\", \"Builtin.ProfessionalStyleAndTone\", You can also specify the following responsible AI related metrics only for model evaluation job that use a LLM as judge \"Builtin.Harmfulness\", \"Builtin.Stereotyping\", and \"Builtin.Refusal\".

For human-based model evaluation jobs, the list of strings must match the name parameter specified in HumanEvaluationCustomMetric.

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

Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.

" + } + }, + "jobTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

Tags to attach to the model evaluation job.

" + } + }, + "applicationType": { + "target": "com.amazonaws.bedrock#ApplicationType", + "traits": { + "smithy.api#documentation": "

Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

" + } + }, + "evaluationConfig": { + "target": "com.amazonaws.bedrock#EvaluationConfig", + "traits": { + "smithy.api#documentation": "

Contains the configuration details of either an automated or human-based evaluation job.

", + "smithy.api#required": {} + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", + "traits": { + "smithy.api#documentation": "

Contains the configuration details of the inference model for the evaluation job.

For model evaluation jobs, automated jobs support a single model or inference profile, and jobs that use human workers support two models or inference profiles.

", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", + "traits": { + "smithy.api#documentation": "

Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

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

Defines the prompt datasets, built-in metric names and custom metric names, and the task type.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfig" + "com.amazonaws.bedrock#CreateEvaluationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#EvaluationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the evaluation job.

", + "smithy.api#required": {} + } + } }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#EvaluationDatasetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 + "com.amazonaws.bedrock#CreateFoundationModelAgreement": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateFoundationModelAgreementRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateFoundationModelAgreementResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", - "smithy.api#sensitive": {} + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Request a model access agreement for the specified model.

", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/create-foundation-model-agreement" + } } }, - "com.amazonaws.bedrock#EvaluationInferenceConfig": { - "type": "union", + "com.amazonaws.bedrock#CreateFoundationModelAgreementRequest": { + "type": "structure", "members": { - "models": { - "target": "com.amazonaws.bedrock#EvaluationModelConfigs", + "offerToken": { + "target": "com.amazonaws.bedrock#OfferToken", "traits": { - "smithy.api#documentation": "

Specifies the inference models.

" + "smithy.api#documentation": "

An offer token encapsulates the information for an offer.

", + "smithy.api#required": {} } }, - "ragConfigs": { - "target": "com.amazonaws.bedrock#RagConfigs", + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", "traits": { - "smithy.api#documentation": "

Contains the configuration details of the inference for a knowledge base evaluation job, including either the retrieval only configuration or the retrieval with response generation configuration.

" + "smithy.api#documentation": "

Model Id of the model for the access request.

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

The configuration details of the inference model for an evaluation job.

For automated model evaluation jobs, only a single model is supported.

For human-based model evaluation jobs, your annotator can compare the responses for up to two different models.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#EvaluationInferenceConfigSummary": { + "com.amazonaws.bedrock#CreateFoundationModelAgreementResponse": { "type": "structure", "members": { - "modelConfigSummary": { - "target": "com.amazonaws.bedrock#EvaluationModelConfigSummary", - "traits": { - "smithy.api#documentation": "

A summary of the models used in an Amazon Bedrock model evaluation job. These resources can be models in Amazon Bedrock or models outside of Amazon Bedrock that you use to generate your own inference response data.

" - } - }, - "ragConfigSummary": { - "target": "com.amazonaws.bedrock#EvaluationRagConfigSummary", + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", "traits": { - "smithy.api#documentation": "

A summary of the RAG resources used in an Amazon Bedrock Knowledge Base evaluation job. These resources can be Knowledge Bases in Amazon Bedrock or RAG sources outside of Amazon Bedrock that you use to generate your own inference response data.

" + "smithy.api#documentation": "

Model Id of the model for the access request.

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

Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.

" - } - }, - "com.amazonaws.bedrock#EvaluationJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1011 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12}$" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#EvaluationJobDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 + "com.amazonaws.bedrock#CreateGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateGuardrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "smithy.api#pattern": "^.+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#EvaluationJobIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1011 + { + "target": "com.amazonaws.bedrock#ConflictException" }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#EvaluationJobIdentifiers": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationJobIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.bedrock#EvaluationJobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 + { + "target": "com.amazonaws.bedrock#InternalServerException" }, - "smithy.api#pattern": "^[a-z0-9](-*[a-z0-9]){0,62}$" - } - }, - "com.amazonaws.bedrock#EvaluationJobResource": { - "type": "resource", - "operations": [ { - "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJob" + "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, { - "target": "com.amazonaws.bedrock#CreateEvaluationJob" + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" }, { - "target": "com.amazonaws.bedrock#GetEvaluationJob" + "target": "com.amazonaws.bedrock#ThrottlingException" }, { - "target": "com.amazonaws.bedrock#ListEvaluationJobs" + "target": "com.amazonaws.bedrock#TooManyTagsException" }, { - "target": "com.amazonaws.bedrock#StopEvaluationJob" + "target": "com.amazonaws.bedrock#ValidationException" } - ] + ], + "traits": { + "smithy.api#documentation": "

Creates a guardrail to block topics and to implement safeguards for your generative AI applications.

You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.

  • Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.

  • Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.

  • Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.

  • Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.

In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.

For more information, see Amazon Bedrock Guardrails in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/guardrails" + } + } }, - "com.amazonaws.bedrock#EvaluationJobStatus": { - "type": "enum", + "com.amazonaws.bedrock#CreateGuardrailRequest": { + "type": "structure", "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", + "name": { + "target": "com.amazonaws.bedrock#GuardrailName", "traits": { - "smithy.api#enumValue": "InProgress" + "smithy.api#documentation": "

The name to give the guardrail.

", + "smithy.api#required": {} } }, - "COMPLETED": { - "target": "smithy.api#Unit", + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", "traits": { - "smithy.api#enumValue": "Completed" + "smithy.api#documentation": "

A description of the guardrail.

" } }, - "FAILED": { - "target": "smithy.api#Unit", + "topicPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailTopicPolicyConfig", "traits": { - "smithy.api#enumValue": "Failed" + "smithy.api#documentation": "

The topic policies to configure for the guardrail.

" } }, - "STOPPING": { - "target": "smithy.api#Unit", + "contentPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContentPolicyConfig", "traits": { - "smithy.api#enumValue": "Stopping" + "smithy.api#documentation": "

The content filter policies to configure for the guardrail.

" } }, - "STOPPED": { - "target": "smithy.api#Unit", + "wordPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailWordPolicyConfig", "traits": { - "smithy.api#enumValue": "Stopped" + "smithy.api#documentation": "

The word policy you configure for the guardrail.

" } }, - "DELETING": { - "target": "smithy.api#Unit", + "sensitiveInformationPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig", "traits": { - "smithy.api#enumValue": "Deleting" + "smithy.api#documentation": "

The sensitive information policy to configure for the guardrail.

" } - } - } - }, - "com.amazonaws.bedrock#EvaluationJobType": { - "type": "enum", - "members": { - "HUMAN": { - "target": "smithy.api#Unit", + }, + "contextualGroundingPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig", "traits": { - "smithy.api#enumValue": "Human" + "smithy.api#documentation": "

The contextual grounding policy configuration used to create a guardrail.

" } }, - "AUTOMATED": { - "target": "smithy.api#Unit", + "automatedReasoningPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailAutomatedReasoningPolicyConfig", "traits": { - "smithy.api#enumValue": "Automated" + "smithy.api#documentation": "

Optional configuration for integrating Automated Reasoning policies with the new guardrail.

" } - } - } - }, - "com.amazonaws.bedrock#EvaluationMetricDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 }, - "smithy.api#pattern": "^.+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#EvaluationMetricName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 + "crossRegionConfig": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionConfig", + "traits": { + "smithy.api#documentation": "

The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.

For more information, see the Amazon Bedrock User Guide.

" + } }, - "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#EvaluationMetricNames": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationMetricName" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.bedrock#EvaluationModelConfig": { - "type": "union", - "members": { - "bedrockModel": { - "target": "com.amazonaws.bedrock#EvaluationBedrockModel", + "blockedInputMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", "traits": { - "smithy.api#documentation": "

Defines the Amazon Bedrock model or inference profile and inference parameters you want used.

" + "smithy.api#documentation": "

The message to return when the guardrail blocks a prompt.

", + "smithy.api#required": {} } }, - "precomputedInferenceSource": { - "target": "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSource", + "blockedOutputsMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", "traits": { - "smithy.api#documentation": "

Defines the model used to generate inference response data for a model evaluation job where you provide your own inference response data.

" + "smithy.api#documentation": "

The message to return when the guardrail blocks a model response.

", + "smithy.api#required": {} + } + }, + "kmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that you use to encrypt the guardrail.

" + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

The tags that you want to attach to the guardrail.

" + } + }, + "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 once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

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

Defines the models used in the model evaluation job.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#EvaluationModelConfigSummary": { + "com.amazonaws.bedrock#CreateGuardrailResponse": { "type": "structure", "members": { - "bedrockModelIdentifiers": { - "target": "com.amazonaws.bedrock#EvaluationBedrockModelIdentifiers", + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the models used for the evaluation job.

" + "smithy.api#documentation": "

The unique identifier of the guardrail that was created.

", + "smithy.api#required": {} } }, - "precomputedInferenceSourceIdentifiers": { - "target": "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifiers", + "guardrailArn": { + "target": "com.amazonaws.bedrock#GuardrailArn", "traits": { - "smithy.api#documentation": "

A label that identifies the models used for a model evaluation job where you provide your own inference response data.

" + "smithy.api#documentation": "

The ARN of the guardrail.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailDraftVersion", + "traits": { + "smithy.api#documentation": "

The version of the guardrail that was created. This value will always be DRAFT.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the guardrail was created.

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

A summary of the models used in an Amazon Bedrock model evaluation job. These resources can be models in Amazon Bedrock or models outside of Amazon Bedrock that you use to generate your own inference response data.

" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#EvaluationModelConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationModelConfig" + "com.amazonaws.bedrock#CreateGuardrailVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateGuardrailVersionRequest" }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 + "output": { + "target": "com.amazonaws.bedrock#CreateGuardrailVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" } - } - }, - "com.amazonaws.bedrock#EvaluationModelInferenceParams": { - "type": "string", + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 1023 - }, - "smithy.api#sensitive": {} + "smithy.api#documentation": "

Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.

", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/guardrails/{guardrailIdentifier}" + } } }, - "com.amazonaws.bedrock#EvaluationOutputDataConfig": { + "com.amazonaws.bedrock#CreateGuardrailVersionRequest": { "type": "structure", "members": { - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", "traits": { - "smithy.api#documentation": "

The Amazon S3 URI where the results of the evaluation job are saved.

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

The unique identifier of the guardrail. This can be an ID or the ARN.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "

A description of the guardrail version.

" + } + }, + "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 once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

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

The Amazon S3 location where the results of your evaluation job are saved.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSource": { + "com.amazonaws.bedrock#CreateGuardrailVersionResponse": { "type": "structure", "members": { - "inferenceSourceIdentifier": { - "target": "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifier", + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", "traits": { - "smithy.api#documentation": "

A label that identifies a model used in a model evaluation job where you provide your own inference response data.

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

The unique identifier of the guardrail.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", + "traits": { + "smithy.api#documentation": "

The number of the version of the guardrail.

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

A summary of a model used for a model evaluation job where you provide your own inference response data.

" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]([a-zA-Z0-9._-]){0,255}$" - } - }, - "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifiers": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifier" + "com.amazonaws.bedrock#CreateInferenceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateInferenceProfileRequest" }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 + "output": { + "target": "com.amazonaws.bedrock#CreateInferenceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" } + ], + "traits": { + "smithy.api#documentation": "

Creates an application inference profile to track metrics and costs when invoking a model. To create an application inference profile for a foundation model in one region, specify the ARN of the model in that region. To create an application inference profile for a foundation model across multiple regions, specify the ARN of the system-defined inference profile that contains the regions that you want to route requests to. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/inference-profiles" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceConfig": { - "type": "union", + "com.amazonaws.bedrock#CreateInferenceProfileRequest": { + "type": "structure", "members": { - "retrieveSourceConfig": { - "target": "com.amazonaws.bedrock#EvaluationPrecomputedRetrieveSourceConfig", + "inferenceProfileName": { + "target": "com.amazonaws.bedrock#InferenceProfileName", "traits": { - "smithy.api#documentation": "

A summary of a RAG source used for a retrieve-only Knowledge Base evaluation job where you provide your own inference response data.

" + "smithy.api#documentation": "

A name for the inference profile.

", + "smithy.api#required": {} } }, - "retrieveAndGenerateSourceConfig": { - "target": "com.amazonaws.bedrock#EvaluationPrecomputedRetrieveAndGenerateSourceConfig", + "description": { + "target": "com.amazonaws.bedrock#InferenceProfileDescription", "traits": { - "smithy.api#documentation": "

A summary of a RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.

" + "smithy.api#documentation": "

A description for the inference profile.

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

A summary of a RAG source used for a Knowledge Base evaluation job where you provide your own inference response data.

" - } - }, - "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 }, - "smithy.api#pattern": "^[a-zA-Z0-9]([a-zA-Z0-9._-]){0,255}$" - } - }, - "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifiers": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.bedrock#EvaluationPrecomputedRetrieveAndGenerateSourceConfig": { - "type": "structure", - "members": { - "ragSourceIdentifier": { - "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifier", + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "

A label that identifies the RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.

", - "smithy.api#required": {} + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

A summary of a RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.

" - } - }, - "com.amazonaws.bedrock#EvaluationPrecomputedRetrieveSourceConfig": { - "type": "structure", - "members": { - "ragSourceIdentifier": { - "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifier", + }, + "modelSource": { + "target": "com.amazonaws.bedrock#InferenceProfileModelSource", "traits": { - "smithy.api#documentation": "

A label that identifies the RAG source used for a retrieve-only Knowledge Base evaluation job where you provide your own inference response data.

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

The foundation model or system-defined inference profile that the inference profile will track metrics and costs for.

", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

An array of objects, each of which contains a tag and its value. For more information, see Tagging resources in the Amazon Bedrock User Guide.

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

A summary of a RAG source used for a retrieve-only Knowledge Base evaluation job where you provide your own inference response data.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#EvaluationRagConfigSummary": { + "com.amazonaws.bedrock#CreateInferenceProfileResponse": { "type": "structure", "members": { - "bedrockKnowledgeBaseIdentifiers": { - "target": "com.amazonaws.bedrock#EvaluationBedrockKnowledgeBaseIdentifiers", + "inferenceProfileArn": { + "target": "com.amazonaws.bedrock#InferenceProfileArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Knowledge Base resources used for a Knowledge Base evaluation job where Amazon Bedrock invokes the Knowledge Base for you.

" + "smithy.api#documentation": "

The ARN of the inference profile that you created.

", + "smithy.api#required": {} } }, - "precomputedRagSourceIdentifiers": { - "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifiers", + "status": { + "target": "com.amazonaws.bedrock#InferenceProfileStatus", "traits": { - "smithy.api#documentation": "

A label that identifies the RAG sources used for a Knowledge Base evaluation job where you provide your own inference response data.

" + "smithy.api#documentation": "

The status of the inference profile. ACTIVE means that the inference profile is ready to be used.

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

A summary of the RAG resources used in an Amazon Bedrock Knowledge Base evaluation job. These resources can be Knowledge Bases in Amazon Bedrock or RAG sources outside of Amazon Bedrock that you use to generate your own inference response data.

" - } - }, - "com.amazonaws.bedrock#EvaluationRatingMethod": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[0-9a-zA-Z-_]+$" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#EvaluationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationSummary" + "com.amazonaws.bedrock#CreateMarketplaceModelEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateMarketplaceModelEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateMarketplaceModelEndpointResponse" }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 + "smithy.api#documentation": "

Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/marketplace-model/endpoints" } } }, - "com.amazonaws.bedrock#EvaluationSummary": { + "com.amazonaws.bedrock#CreateMarketplaceModelEndpointRequest": { "type": "structure", "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#EvaluationJobArn", + "modelSourceIdentifier": { + "target": "com.amazonaws.bedrock#ModelSourceIdentifier", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the evaluation job.

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

The ARN of the model from Amazon Bedrock Marketplace that you want to deploy to the endpoint.

", "smithy.api#required": {} } }, - "jobName": { - "target": "com.amazonaws.bedrock#EvaluationJobName", + "endpointConfig": { + "target": "com.amazonaws.bedrock#EndpointConfig", "traits": { - "smithy.api#documentation": "

The name for the evaluation job.

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

The configuration for the endpoint, including the number and type of instances to use.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "acceptEula": { + "target": "com.amazonaws.bedrock#AcceptEula", "traits": { - "smithy.api#documentation": "

The current status of the evaluation job.

", - "smithy.api#required": {} + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether you accept the end-user license agreement (EULA) for the model. Set to true to accept the EULA.

" } }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "endpointName": { + "target": "com.amazonaws.bedrock#EndpointName", "traits": { - "smithy.api#documentation": "

The time the evaluation job was created.

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

The name of the endpoint. This name must be unique within your Amazon Web Services account and region.

", "smithy.api#required": {} } }, - "jobType": { - "target": "com.amazonaws.bedrock#EvaluationJobType", + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Specifies whether the evaluation job is automated or human-based.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is listed as not required because Amazon Web Services SDKs automatically generate it for you and set this parameter. If you're not using the Amazon Web Services SDK or the CLI, you must provide this token or the action will fail.

", + "smithy.api#idempotencyToken": {} } }, - "evaluationTaskTypes": { - "target": "com.amazonaws.bedrock#EvaluationTaskTypes", + "tags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "

The type of task for model evaluation.

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

An array of key-value pairs to apply to the underlying Amazon SageMaker endpoint. You can use these tags to organize and identify your Amazon Web Services resources.

" } - }, - "modelIdentifiers": { - "target": "com.amazonaws.bedrock#EvaluationBedrockModelIdentifiers", - "traits": { - "smithy.api#addedDefault": {}, - "smithy.api#default": [], - "smithy.api#deprecated": { - "since": "2025-03-07", - "message": "Inference identifiers should be retrieved from the inferenceConfigSummary" - }, - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.

" - } - }, - "ragIdentifiers": { - "target": "com.amazonaws.bedrock#EvaluationBedrockKnowledgeBaseIdentifiers", - "traits": { - "smithy.api#deprecated": { - "since": "2025-03-07", - "message": "Inference identifiers should be retrieved from the inferenceConfigSummary" - }, - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.

" - } - }, - "evaluatorModelIdentifiers": { - "target": "com.amazonaws.bedrock#EvaluatorModelIdentifiers", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateMarketplaceModelEndpointResponse": { + "type": "structure", + "members": { + "marketplaceModelEndpoint": { + "target": "com.amazonaws.bedrock#MarketplaceModelEndpoint", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.

" + "smithy.api#documentation": "

Details about the created endpoint.

", + "smithy.api#required": {} } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateModelCopyJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateModelCopyJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateModelCopyJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "customMetricsEvaluatorModelIdentifiers": { - "target": "com.amazonaws.bedrock#EvaluatorModelIdentifiers", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.

" - } + { + "target": "com.amazonaws.bedrock#InternalServerException" }, - "inferenceConfigSummary": { - "target": "com.amazonaws.bedrock#EvaluationInferenceConfigSummary", - "traits": { - "smithy.api#documentation": "

Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.

" - } + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, - "applicationType": { - "target": "com.amazonaws.bedrock#ApplicationType", - "traits": { - "smithy.api#documentation": "

Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

" - } + { + "target": "com.amazonaws.bedrock#TooManyTagsException" } - }, + ], "traits": { - "smithy.api#documentation": "

Summary information of an evaluation job.

" + "smithy.api#documentation": "

Copies a model to another region so that it can be used there. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/model-copy-jobs" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#EvaluationTaskType": { - "type": "enum", + "com.amazonaws.bedrock#CreateModelCopyJobRequest": { + "type": "structure", "members": { - "SUMMARIZATION": { - "target": "smithy.api#Unit", + "sourceModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", "traits": { - "smithy.api#enumValue": "Summarization" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model to be copied.

", + "smithy.api#required": {} } }, - "CLASSIFICATION": { - "target": "smithy.api#Unit", + "targetModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", "traits": { - "smithy.api#enumValue": "Classification" + "smithy.api#documentation": "

A name for the copied model.

", + "smithy.api#required": {} } }, - "QUESTION_AND_ANSWER": { - "target": "smithy.api#Unit", + "modelKmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", "traits": { - "smithy.api#enumValue": "QuestionAndAnswer" + "smithy.api#documentation": "

The ARN of the KMS key that you use to encrypt the model copy.

" } }, - "GENERATION": { - "target": "smithy.api#Unit", + "targetModelTags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#enumValue": "Generation" + "smithy.api#documentation": "

Tags to associate with the target model. For more information, see Tag resources in the Amazon Bedrock User Guide.

" } }, - "CUSTOM": { - "target": "smithy.api#Unit", + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#enumValue": "Custom" + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[A-Za-z0-9]+$" - } - }, - "com.amazonaws.bedrock#EvaluationTaskTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationTaskType" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#EvaluatorModelConfig": { - "type": "union", + "com.amazonaws.bedrock#CreateModelCopyJobResponse": { + "type": "structure", "members": { - "bedrockEvaluatorModels": { - "target": "com.amazonaws.bedrock#BedrockEvaluatorModels", + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", "traits": { - "smithy.api#documentation": "

The evaluator model used in knowledge base evaluation job or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model copy job.

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

Specifies the model configuration for the evaluator model. EvaluatorModelConfig is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

" - } - }, - "com.amazonaws.bedrock#EvaluatorModelIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "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}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))))$|(^[a-z0-9-]+[.][a-z0-9-]+([.][a-z0-9-]+)*(:[a-z0-9-]+)?$)|^[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)$" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#EvaluatorModelIdentifiers": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluatorModelIdentifier" + "com.amazonaws.bedrock#CreateModelCustomizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateModelCustomizationJobRequest" }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 + "output": { + "target": "com.amazonaws.bedrock#CreateModelCustomizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" } + ], + "traits": { + "smithy.api#documentation": "

Creates a fine-tuning job to customize a base model.

You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.

For information on the format of training and validation data, see Prepare the datasets.

Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.

For more information, see Custom models in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/model-customization-jobs" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#ExternalSource": { + "com.amazonaws.bedrock#CreateModelCustomizationJobRequest": { "type": "structure", "members": { - "sourceType": { - "target": "com.amazonaws.bedrock#ExternalSourceType", + "jobName": { + "target": "com.amazonaws.bedrock#JobName", "traits": { - "smithy.api#documentation": "

The source type of the external source wrapper object.

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

A name for the fine-tuning job.

", "smithy.api#required": {} } }, - "s3Location": { - "target": "com.amazonaws.bedrock#S3ObjectDoc", + "customModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", "traits": { - "smithy.api#documentation": "

The S3 location of the external source wrapper object.

" + "smithy.api#documentation": "

A name for the resulting custom model.

", + "smithy.api#required": {} } }, - "byteContent": { - "target": "com.amazonaws.bedrock#ByteContentDoc", + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", "traits": { - "smithy.api#documentation": "

The identifier, content type, and data of the external source wrapper object.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.

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

The unique external source of the content contained in the wrapper object.

" - } - }, - "com.amazonaws.bedrock#ExternalSourceType": { - "type": "enum", - "members": { - "S3": { - "target": "smithy.api#Unit", + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#enumValue": "S3" + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} } }, - "BYTE_CONTENT": { - "target": "smithy.api#Unit", + "baseModelIdentifier": { + "target": "com.amazonaws.bedrock#BaseModelIdentifier", "traits": { - "smithy.api#enumValue": "BYTE_CONTENT" + "smithy.api#documentation": "

Name of the base model.

", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.bedrock#ExternalSources": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ExternalSource" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.bedrock#ExternalSourcesGenerationConfiguration": { - "type": "structure", - "members": { - "promptTemplate": { - "target": "com.amazonaws.bedrock#PromptTemplate", + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", "traits": { - "smithy.api#documentation": "

Contains the template for the prompt for the external source wrapper object.

" + "smithy.api#documentation": "

The customization type.

" } }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrock#GuardrailConfiguration", + "customModelKmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", "traits": { - "smithy.api#documentation": "

Configuration details for the guardrail.

" + "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" } }, - "kbInferenceConfig": { - "target": "com.amazonaws.bedrock#KbInferenceConfig", + "jobTags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "

Configuration details for inference when using RetrieveAndGenerate to generate responses while using an external source.

" + "smithy.api#documentation": "

Tags to attach to the job.

" } }, - "additionalModelRequestFields": { - "target": "com.amazonaws.bedrock#AdditionalModelRequestFields", + "customModelTags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "

Additional model parameters and their corresponding values not included in the text inference configuration for an external source. Takes in custom model parameters specific to the language model being used.

" + "smithy.api#documentation": "

Tags to attach to the resulting custom model.

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

The response generation configuration of the external source wrapper object.

" - } - }, - "com.amazonaws.bedrock#ExternalSourcesRetrieveAndGenerateConfiguration": { - "type": "structure", - "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#BedrockModelArn", + }, + "trainingDataConfig": { + "target": "com.amazonaws.bedrock#TrainingDataConfig", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the foundation model or inference profile used to generate responses.

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

Information about the training dataset.

", "smithy.api#required": {} } }, - "sources": { - "target": "com.amazonaws.bedrock#ExternalSources", + "validationDataConfig": { + "target": "com.amazonaws.bedrock#ValidationDataConfig", "traits": { - "smithy.api#documentation": "

The document for the external source wrapper object in the retrieveAndGenerate function.

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

Information about the validation dataset.

" + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

S3 location for the output data.

", "smithy.api#required": {} } }, - "generationConfiguration": { - "target": "com.amazonaws.bedrock#ExternalSourcesGenerationConfiguration", + "hyperParameters": { + "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", "traits": { - "smithy.api#documentation": "

Contains configurations details for response generation based on retrieved text chunks.

" + "smithy.api#documentation": "

Parameters related to tuning the model. For details on the format for different models, see Custom model hyperparameters.

" + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) that contains the resources that you're using for this job. For more information, see Protect your model customization jobs using a VPC.

" + } + }, + "customizationConfig": { + "target": "com.amazonaws.bedrock#CustomizationConfig", + "traits": { + "smithy.api#documentation": "

The customization configuration for the model customization job.

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

The configuration of the external source wrapper object in the retrieveAndGenerate function.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#FieldForReranking": { + "com.amazonaws.bedrock#CreateModelCustomizationJobResponse": { "type": "structure", "members": { - "fieldName": { - "target": "smithy.api#String", + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", "traits": { - "smithy.api#documentation": "

The name of the metadata field to be used during the reranking process.

", - "smithy.api#length": { - "min": 1, - "max": 2000 - }, + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the fine tuning job

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

Specifies a field to be used during the reranking process in a Knowledge Base vector search. This structure identifies metadata fields that should be considered when reordering search results to improve relevance.

" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#FieldsForReranking": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#FieldForReranking" + "com.amazonaws.bedrock#CreateModelImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateModelImportJobRequest" }, + "output": { + "target": "com.amazonaws.bedrock#CreateModelImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 + "smithy.api#documentation": "

Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker. For more information, see Import a customized model

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/model-import-jobs" }, - "smithy.api#sensitive": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#FilterAttribute": { + "com.amazonaws.bedrock#CreateModelImportJobRequest": { "type": "structure", "members": { - "key": { - "target": "com.amazonaws.bedrock#FilterKey", + "jobName": { + "target": "com.amazonaws.bedrock#JobName", "traits": { - "smithy.api#documentation": "

The name of metadata attribute/field, which must match the name in your data source/document metadata.

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

The name of the import job.

", "smithy.api#required": {} } }, - "value": { - "target": "com.amazonaws.bedrock#FilterValue", + "importedModelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", "traits": { - "smithy.api#documentation": "

The value of the metadata attribute/field.

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

The name of the imported model.

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

Specifies the name of the metadata attribute/field to apply filters. You must match the name of the attribute/field in your data source/document metadata.

" - } - }, - "com.amazonaws.bedrock#FilterKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.bedrock#FilterValue": { - "type": "document" - }, - "com.amazonaws.bedrock#FineTuningJobStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", "traits": { - "smithy.api#enumValue": "InProgress" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model import job.

", + "smithy.api#required": {} } }, - "COMPLETED": { - "target": "smithy.api#Unit", + "modelDataSource": { + "target": "com.amazonaws.bedrock#ModelDataSource", "traits": { - "smithy.api#enumValue": "Completed" + "smithy.api#documentation": "

The data source for the imported model.

", + "smithy.api#required": {} } }, - "FAILED": { - "target": "smithy.api#Unit", + "jobTags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#enumValue": "Failed" + "smithy.api#documentation": "

Tags to attach to this import job.

" } }, - "STOPPING": { - "target": "smithy.api#Unit", + "importedModelTags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#enumValue": "Stopping" + "smithy.api#documentation": "

Tags to attach to the imported model.

" } }, - "STOPPED": { - "target": "smithy.api#Unit", + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#enumValue": "Stopped" + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "

VPC configuration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for the import job.

" + } + }, + "importedModelKmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The imported model is encrypted at rest using this key.

" } } - } - }, - "com.amazonaws.bedrock#FoundationModelArn": { - "type": "string", + }, "traits": { - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#FoundationModelDetails": { + "com.amazonaws.bedrock#CreateModelImportJobResponse": { "type": "structure", "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", - "traits": { - "smithy.api#documentation": "

The model Amazon Resource Name (ARN).

", - "smithy.api#required": {} - } - }, - "modelId": { - "target": "com.amazonaws.bedrock#BedrockModelId", + "jobArn": { + "target": "com.amazonaws.bedrock#ModelImportJobArn", "traits": { - "smithy.api#documentation": "

The model identifier.

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

The Amazon Resource Name (ARN) of the model import job.

", "smithy.api#required": {} } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateModelInvocationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateModelInvocationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateModelInvocationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "modelName": { - "target": "com.amazonaws.bedrock#BrandedName", - "traits": { - "smithy.api#documentation": "

The model name.

" - } - }, - "providerName": { - "target": "com.amazonaws.bedrock#BrandedName", - "traits": { - "smithy.api#documentation": "

The model's provider name.

" - } - }, - "inputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", - "traits": { - "smithy.api#documentation": "

The input modalities that the model supports.

" - } + { + "target": "com.amazonaws.bedrock#ConflictException" }, - "outputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", - "traits": { - "smithy.api#documentation": "

The output modalities that the model supports.

" - } + { + "target": "com.amazonaws.bedrock#InternalServerException" }, - "responseStreamingSupported": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the model supports streaming.

" - } + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, - "customizationsSupported": { - "target": "com.amazonaws.bedrock#ModelCustomizationList", - "traits": { - "smithy.api#documentation": "

The customization that the model supports.

" - } + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" }, - "inferenceTypesSupported": { - "target": "com.amazonaws.bedrock#InferenceTypeList", - "traits": { - "smithy.api#documentation": "

The inference types that the model supports.

" - } + { + "target": "com.amazonaws.bedrock#ThrottlingException" }, - "modelLifecycle": { - "target": "com.amazonaws.bedrock#FoundationModelLifecycle", - "traits": { - "smithy.api#documentation": "

Contains details about whether a model version is available or deprecated

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

Information about a foundation model.

" - } - }, - "com.amazonaws.bedrock#FoundationModelLifecycle": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.bedrock#FoundationModelLifecycleStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether a model version is available (ACTIVE) or deprecated (LEGACY.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.bedrock#ValidationException" } - }, + ], "traits": { - "smithy.api#documentation": "

Details about whether a model version is available or deprecated.

" - } - }, - "com.amazonaws.bedrock#FoundationModelLifecycleStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } + "smithy.api#documentation": "

Creates a batch inference job to invoke a model on multiple prompts. Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Process multiple prompts with batch inference.

The response returns a jobArn that you can use to stop or get details about the job.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/model-invocation-job" }, - "LEGACY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEGACY" - } - } + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#FoundationModelSummary": { + "com.amazonaws.bedrock#CreateModelInvocationJobRequest": { "type": "structure", "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", + "jobName": { + "target": "com.amazonaws.bedrock#ModelInvocationJobName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the foundation model.

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

A name to give the batch inference job.

", "smithy.api#required": {} } }, - "modelId": { - "target": "com.amazonaws.bedrock#BedrockModelId", + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", "traits": { - "smithy.api#documentation": "

The model ID of the foundation model.

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

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

", "smithy.api#required": {} } }, - "modelName": { - "target": "com.amazonaws.bedrock#BrandedName", - "traits": { - "smithy.api#documentation": "

The name of the model.

" - } - }, - "providerName": { - "target": "com.amazonaws.bedrock#BrandedName", + "clientRequestToken": { + "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", "traits": { - "smithy.api#documentation": "

The model's provider name.

" + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} } }, - "inputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", + "modelId": { + "target": "com.amazonaws.bedrock#ModelId", "traits": { - "smithy.api#documentation": "

The input modalities that the model supports.

" + "smithy.api#documentation": "

The unique identifier of the foundation model to use for the batch inference job.

", + "smithy.api#required": {} } }, - "outputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", + "inputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", "traits": { - "smithy.api#documentation": "

The output modalities that the model supports.

" + "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

", + "smithy.api#required": {} } }, - "responseStreamingSupported": { - "target": "smithy.api#Boolean", + "outputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", "traits": { - "smithy.api#documentation": "

Indicates whether the model supports streaming.

" + "smithy.api#documentation": "

Details about the location of the output of the batch inference job.

", + "smithy.api#required": {} } }, - "customizationsSupported": { - "target": "com.amazonaws.bedrock#ModelCustomizationList", + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", "traits": { - "smithy.api#documentation": "

Whether the model supports fine-tuning or continual pre-training.

" + "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

" } }, - "inferenceTypesSupported": { - "target": "com.amazonaws.bedrock#InferenceTypeList", + "timeoutDurationInHours": { + "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", "traits": { - "smithy.api#documentation": "

The inference types that the model supports.

" + "smithy.api#documentation": "

The number of hours after which to force the batch inference job to time out.

" } }, - "modelLifecycle": { - "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "tags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "

Contains details about whether a model version is available or deprecated.

" + "smithy.api#documentation": "

Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

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

Summary information for a foundation model.

" - } - }, - "com.amazonaws.bedrock#FoundationModelSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#FoundationModelSummary" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GenerationConfiguration": { + "com.amazonaws.bedrock#CreateModelInvocationJobResponse": { "type": "structure", "members": { - "promptTemplate": { - "target": "com.amazonaws.bedrock#PromptTemplate", - "traits": { - "smithy.api#documentation": "

Contains the template for the prompt that's sent to the model for response generation.

" - } - }, - "guardrailConfiguration": { - "target": "com.amazonaws.bedrock#GuardrailConfiguration", - "traits": { - "smithy.api#documentation": "

Contains configuration details for the guardrail.

" - } - }, - "kbInferenceConfig": { - "target": "com.amazonaws.bedrock#KbInferenceConfig", - "traits": { - "smithy.api#documentation": "

Contains configuration details for inference for knowledge base retrieval and response generation.

" - } - }, - "additionalModelRequestFields": { - "target": "com.amazonaws.bedrock#AdditionalModelRequestFields", + "jobArn": { + "target": "com.amazonaws.bedrock#ModelInvocationJobArn", "traits": { - "smithy.api#documentation": "

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows you to provide custom model parameters specific to the language model being used.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

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

The configuration details for response generation based on retrieved text chunks.

" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetCustomModel": { + "com.amazonaws.bedrock#CreatePromptRouter": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetCustomModelRequest" + "target": "com.amazonaws.bedrock#CreatePromptRouterRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetCustomModelResponse" + "target": "com.amazonaws.bedrock#CreatePromptRouterResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, { "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.bedrock#ThrottlingException" }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, { "target": "com.amazonaws.bedrock#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Get the properties associated with a Amazon Bedrock custom model that you have created. For more information, see Custom models in the Amazon Bedrock User Guide.

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

Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.

", "smithy.api#http": { "code": 200, - "method": "GET", - "uri": "/custom-models/{modelIdentifier}" + "method": "POST", + "uri": "/prompt-routers" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#GetCustomModelDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetCustomModelDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetCustomModelDeploymentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" + "com.amazonaws.bedrock#CreatePromptRouterRequest": { + "type": "structure", + "members": { + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure idempotency of your requests. If not specified, the Amazon Web Services SDK automatically generates one for you.

", + "smithy.api#idempotencyToken": {} + } }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" + "promptRouterName": { + "target": "com.amazonaws.bedrock#PromptRouterName", + "traits": { + "smithy.api#documentation": "

The name of the prompt router. The name must be unique within your Amazon Web Services account in the current region.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves information about a custom model deployment, including its status, configuration, and metadata. Use this operation to monitor the deployment status and retrieve details needed for inference requests.

The following actions are related to the GetCustomModelDeployment operation:

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/model-customization/custom-model-deployments/{customModelDeploymentIdentifier}" + "models": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModels", + "traits": { + "smithy.api#documentation": "

A list of foundation models that the prompt router can route requests to. At least one model must be specified.

", + "smithy.api#required": {} + } }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#GetCustomModelDeploymentRequest": { - "type": "structure", - "members": { - "customModelDeploymentIdentifier": { - "target": "com.amazonaws.bedrock#CustomModelDeploymentIdentifier", + "description": { + "target": "com.amazonaws.bedrock#PromptRouterDescription", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the custom model deployment to retrieve information about.

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

An optional description of the prompt router to help identify its purpose.

" + } + }, + "routingCriteria": { + "target": "com.amazonaws.bedrock#RoutingCriteria", + "traits": { + "smithy.api#documentation": "

The criteria, which is the response quality difference, used to determine how incoming requests are routed to different models.

", + "smithy.api#required": {} + } + }, + "fallbackModel": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModel", + "traits": { + "smithy.api#documentation": "

The default model to use when the routing criteria is not met.

", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

An array of key-value pairs to apply to this resource as tags. You can use tags to categorize and manage your Amazon Web Services resources.

" + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GetCustomModelDeploymentResponse": { + "com.amazonaws.bedrock#CreatePromptRouterResponse": { "type": "structure", "members": { - "customModelDeploymentArn": { - "target": "com.amazonaws.bedrock#CustomModelDeploymentArn", + "promptRouterArn": { + "target": "com.amazonaws.bedrock#PromptRouterArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model deployment.

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

The Amazon Resource Name (ARN) that uniquely identifies the prompt router.

" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "modelDeploymentName": { - "target": "com.amazonaws.bedrock#ModelDeploymentName", + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/provisioned-model-throughput" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "

The name of the custom model deployment.

", - "smithy.api#required": {} + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

", + "smithy.api#idempotencyToken": {} } }, - "modelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model associated with this deployment.

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

Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the Amazon Web Services support center to request MUs.

For model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide.

For more information about what an MU specifies, contact your Amazon Web Services account manager.

", "smithy.api#required": {} } }, - "createdAt": { - "target": "com.amazonaws.bedrock#Timestamp", + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", "traits": { - "smithy.api#documentation": "

The date and time when the custom model deployment was created.

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

The name for this Provisioned Throughput.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.bedrock#CustomModelDeploymentStatus", + "modelId": { + "target": "com.amazonaws.bedrock#ModelIdentifier", "traits": { - "smithy.api#documentation": "

The status of the custom model deployment. Possible values are:

  • CREATING - The deployment is being set up and prepared for inference.

  • ACTIVE - The deployment is ready and available for inference requests.

  • FAILED - The deployment failed to be created or became unavailable.

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

The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned Throughput in the Amazon Bedrock User Guide.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.bedrock#CustomModelDeploymentDescription", + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", "traits": { - "smithy.api#documentation": "

The description of the custom model deployment.

" + "smithy.api#documentation": "

The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.

Custom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide

" } }, - "failureMessage": { - "target": "com.amazonaws.bedrock#ErrorMessage", + "tags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#documentation": "

If the deployment status is FAILED, this field contains a message describing the failure reason.

" + "smithy.api#documentation": "

Tags to associate with this Provisioned Throughput.

" } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.bedrock#Timestamp", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse": { + "type": "structure", + "members": { + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", "traits": { - "smithy.api#documentation": "

The date and time when the custom model deployment was last updated.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for this Provisioned Throughput.

", + "smithy.api#required": {} } } }, @@ -5542,294 +6163,422 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetCustomModelRequest": { + "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModel": { "type": "structure", "members": { "modelIdentifier": { - "target": "com.amazonaws.bedrock#ModelIdentifier", + "target": "com.amazonaws.bedrock#EvaluatorModelIdentifier", "traits": { - "smithy.api#documentation": "

Name or Amazon Resource Name (ARN) of the custom model.

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

The Amazon Resource Name (ARN) of the evaluator model for custom metrics. For a list of supported evaluator models, see Evaluate model performance using another LLM as a judge and Evaluate the performance of RAG sources using Amazon Bedrock evaluations.

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

Defines the model you want to evaluate custom metrics in an Amazon Bedrock evaluation job.

" } }, - "com.amazonaws.bedrock#GetCustomModelResponse": { + "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModels": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#CustomMetricDefinition": { "type": "structure", "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + "name": { + "target": "com.amazonaws.bedrock#MetricName", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) associated with this model.

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

The name for a custom metric. Names must be unique in your Amazon Web Services region.

", "smithy.api#required": {} } }, - "modelName": { - "target": "com.amazonaws.bedrock#CustomModelName", + "instructions": { + "target": "com.amazonaws.bedrock#CustomMetricInstructions", "traits": { - "smithy.api#documentation": "

Model name associated with this model.

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

The prompt for a custom metric that instructs the evaluator model how to rate the model or RAG source under evaluation.

", "smithy.api#required": {} } }, - "jobName": { - "target": "com.amazonaws.bedrock#JobName", - "traits": { - "smithy.api#documentation": "

Job name associated with this model.

" - } - }, - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "ratingScale": { + "target": "com.amazonaws.bedrock#RatingScale", "traits": { - "smithy.api#documentation": "

Job Amazon Resource Name (ARN) associated with this model. For models that you create with the CreateCustomModel API operation, this is NULL.

" + "smithy.api#documentation": "

Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see Specifying an output schema (rating scale).

" } - }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + } + }, + "traits": { + "smithy.api#documentation": "

The definition of a custom metric for use in an Amazon Bedrock evaluation job. A custom metric definition includes a metric name, prompt (instructions) and optionally, a rating scale. Your prompt must include a task description and input variables. The required input variables are different for model-as-a-judge and RAG evaluations.

For more information about how to define a custom metric in Amazon Bedrock, see Create a prompt for a custom metrics (LLM-as-a-judge model evaluations) and Create a prompt for a custom metrics (RAG evaluations).

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#CustomMetricEvaluatorModelConfig": { + "type": "structure", + "members": { + "bedrockEvaluatorModels": { + "target": "com.amazonaws.bedrock#CustomMetricBedrockEvaluatorModels", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the base model.

" + "smithy.api#documentation": "

Defines the model you want to evaluate custom metrics in an Amazon Bedrock evaluation job.

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

Configuration of the evaluator model you want to use to evaluate custom metrics in an Amazon Bedrock evaluation job.

" + } + }, + "com.amazonaws.bedrock#CustomMetricInstructions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 + } + } + }, + "com.amazonaws.bedrock#CustomModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", - "traits": { - "smithy.api#documentation": "

The type of model customization.

" - } + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#CustomModelDeploymentArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 }, - "modelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" - } + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#CustomModelDeploymentDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 }, - "hyperParameters": { - "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrock#CustomModelDeploymentIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 93 + }, + "smithy.api#pattern": "^(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12})|^([0-9a-zA-Z][_-]?){1,63}$" + } + }, + "com.amazonaws.bedrock#CustomModelDeploymentResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateCustomModelDeployment" + }, + { + "target": "com.amazonaws.bedrock#DeleteCustomModelDeployment" + }, + { + "target": "com.amazonaws.bedrock#GetCustomModelDeployment" + }, + { + "target": "com.amazonaws.bedrock#ListCustomModelDeployments" + } + ] + }, + "com.amazonaws.bedrock#CustomModelDeploymentStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.

" + "smithy.api#enumValue": "Creating" } }, - "trainingDataConfig": { - "target": "com.amazonaws.bedrock#TrainingDataConfig", + "ACTIVE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Contains information about the training dataset.

" + "smithy.api#enumValue": "Active" } }, - "validationDataConfig": { - "target": "com.amazonaws.bedrock#ValidationDataConfig", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Contains information about the validation dataset.

" + "smithy.api#enumValue": "Failed" } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#OutputDataConfig", + } + } + }, + "com.amazonaws.bedrock#CustomModelDeploymentSummary": { + "type": "structure", + "members": { + "customModelDeploymentArn": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentArn", "traits": { - "smithy.api#documentation": "

Output data configuration associated with this custom model.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model deployment.

", + "smithy.api#required": {} } }, - "trainingMetrics": { - "target": "com.amazonaws.bedrock#TrainingMetrics", + "customModelDeploymentName": { + "target": "com.amazonaws.bedrock#ModelDeploymentName", "traits": { - "smithy.api#documentation": "

Contains training metrics from the job creation.

" + "smithy.api#documentation": "

The name of the custom model deployment.

", + "smithy.api#required": {} } }, - "validationMetrics": { - "target": "com.amazonaws.bedrock#ValidationMetrics", + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", "traits": { - "smithy.api#documentation": "

The validation metrics from the job creation.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model associated with this deployment.

", + "smithy.api#required": {} } }, - "creationTime": { + "createdAt": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

Creation time of the model.

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

The date and time when the custom model deployment was created.

", "smithy.api#required": {} } }, - "customizationConfig": { - "target": "com.amazonaws.bedrock#CustomizationConfig", + "status": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentStatus", "traits": { - "smithy.api#documentation": "

The customization configuration for the custom model.

" + "smithy.api#documentation": "

The status of the custom model deployment. Possible values are CREATING, ACTIVE, and FAILED.

", + "smithy.api#required": {} } }, - "modelStatus": { - "target": "com.amazonaws.bedrock#ModelStatus", + "lastUpdatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The current status of the custom model. Possible values include:

  • Creating - The model is being created and validated.

  • Active - The model has been successfully created and is ready for use.

  • Failed - The model creation process failed. Check the failureMessage field for details.

" + "smithy.api#documentation": "

The date and time when the custom model deployment was last modified.

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

A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation.

" + "smithy.api#documentation": "

If the deployment status is FAILED, this field contains a message describing the failure reason.

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

Contains summary information about a custom model deployment, including its ARN, name, status, and associated custom model.

" } }, - "com.amazonaws.bedrock#GetEvaluationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetEvaluationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetEvaluationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" + "com.amazonaws.bedrock#CustomModelDeploymentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentSummary" + } + }, + "com.amazonaws.bedrock#CustomModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 }, + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,63}$" + } + }, + "com.amazonaws.bedrock#CustomModelResource": { + "type": "resource", + "operations": [ { - "target": "com.amazonaws.bedrock#InternalServerException" + "target": "com.amazonaws.bedrock#CreateCustomModel" }, { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" + "target": "com.amazonaws.bedrock#DeleteCustomModel" }, { - "target": "com.amazonaws.bedrock#ThrottlingException" + "target": "com.amazonaws.bedrock#GetCustomModel" }, { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about an evaluation job, such as the status of the job.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/evaluation-jobs/{jobIdentifier}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#GetEvaluationJobRequest": { - "type": "structure", - "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the evaluation job you want get information on.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "target": "com.amazonaws.bedrock#ListCustomModels" } - }, - "traits": { - "smithy.api#input": {} - } + ] }, - "com.amazonaws.bedrock#GetEvaluationJobResponse": { + "com.amazonaws.bedrock#CustomModelSummary": { "type": "structure", "members": { - "jobName": { - "target": "com.amazonaws.bedrock#EvaluationJobName", + "modelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", "traits": { - "smithy.api#documentation": "

The name for the evaluation job.

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

The Amazon Resource Name (ARN) of the custom model.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "modelName": { + "target": "com.amazonaws.bedrock#CustomModelName", "traits": { - "smithy.api#documentation": "

The current status of the evaluation job.

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

The name of the custom model.

", "smithy.api#required": {} } }, - "jobArn": { - "target": "com.amazonaws.bedrock#EvaluationJobArn", + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the evaluation job.

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

Creation time of the model.

", "smithy.api#required": {} } }, - "jobDescription": { - "target": "com.amazonaws.bedrock#EvaluationJobDescription", - "traits": { - "smithy.api#documentation": "

The description of the evaluation job.

" - } - }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", + "baseModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role used in the evaluation job.

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

The base model Amazon Resource Name (ARN).

", "smithy.api#required": {} } }, - "customerEncryptionKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer managed encryption key specified when the evaluation job was created.

" - } - }, - "jobType": { - "target": "com.amazonaws.bedrock#EvaluationJobType", + "baseModelName": { + "target": "com.amazonaws.bedrock#ModelName", "traits": { - "smithy.api#documentation": "

Specifies whether the evaluation job is automated or human-based.

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

The base model name.

", "smithy.api#required": {} } }, - "applicationType": { - "target": "com.amazonaws.bedrock#ApplicationType", + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", "traits": { - "smithy.api#documentation": "

Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

" + "smithy.api#documentation": "

Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

" } }, - "evaluationConfig": { - "target": "com.amazonaws.bedrock#EvaluationConfig", + "ownerAccountId": { + "target": "com.amazonaws.bedrock#AccountId", "traits": { - "smithy.api#documentation": "

Contains the configuration details of either an automated or human-based evaluation job.

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

The unique identifier of the account that owns the model.

" } }, - "inferenceConfig": { - "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", + "modelStatus": { + "target": "com.amazonaws.bedrock#ModelStatus", "traits": { - "smithy.api#documentation": "

Contains the configuration details of the inference model used for the evaluation job.

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

The current status of the custom model. Possible values include:

  • Creating - The model is being created and validated.

  • Active - The model has been successfully created and is ready for use.

  • Failed - The model creation process failed.

" } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", + } + }, + "traits": { + "smithy.api#documentation": "

Summary information for a custom model.

" + } + }, + "com.amazonaws.bedrock#CustomModelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#CustomModelSummary" + } + }, + "com.amazonaws.bedrock#CustomModelUnits": { + "type": "structure", + "members": { + "customModelUnitsPerModelCopy": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

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

The number of custom model units used to host a model copy.

" } }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "customModelUnitsVersion": { + "target": "com.amazonaws.bedrock#CustomModelUnitsVersion", "traits": { - "smithy.api#documentation": "

The time the evaluation job was created.

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

The version of the custom model unit. Use to determine the billing rate for the custom model unit.

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

A CustomModelUnit (CMU) is an abstract view of the hardware utilization that Amazon Bedrock needs to host a single copy of your custom model. A model copy represents a single instance of your imported model that is ready to serve inference requests. Amazon Bedrock determines the number of custom model units that a model copy needs when you import the custom model.

You can use CustomModelUnits to estimate the cost of running your custom model. For more information, see Calculate the cost of running a custom model in the Amazon Bedrock user guide.

" + } + }, + "com.amazonaws.bedrock#CustomModelUnitsVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^v\\d+.\\d+$" + } + }, + "com.amazonaws.bedrock#CustomizationConfig": { + "type": "union", + "members": { + "distillationConfig": { + "target": "com.amazonaws.bedrock#DistillationConfig", + "traits": { + "smithy.api#documentation": "

The Distillation configuration for the custom model.

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

A model customization configuration

" + } + }, + "com.amazonaws.bedrock#CustomizationType": { + "type": "enum", + "members": { + "FINE_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINE_TUNING" } }, - "lastModifiedTime": { + "CONTINUED_PRE_TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" + } + }, + "DISTILLATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTILLATION" + } + }, + "IMPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORTED" + } + } + } + }, + "com.amazonaws.bedrock#DataProcessingDetails": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrock#JobStatusDetails", + "traits": { + "smithy.api#documentation": "

The status of the data processing sub-task of the job.

" + } + }, + "creationTime": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The time the evaluation job was last modified.

" + "smithy.api#documentation": "

The start time of the data processing sub-task of the job.

" } }, - "failureMessages": { - "target": "com.amazonaws.bedrock#ErrorMessages", + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

A list of strings that specify why the evaluation job failed to create.

" + "smithy.api#documentation": "

The latest update to the data processing sub-task of the job.

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

For a Distillation job, the status details for the data processing sub-task of the job.

" } }, - "com.amazonaws.bedrock#GetFoundationModel": { + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicy": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetFoundationModelRequest" + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetFoundationModelResponse" + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyResponse" }, "errors": [ { @@ -5849,27 +6598,30 @@ } ], "traits": { - "smithy.api#documentation": "

Get details about a Amazon Bedrock foundation model.

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

Deletes an Automated Reasoning policy or policy version. This operation is idempotent. If you delete a policy more than once, each call succeeds. Deleting a policy removes it permanently and cannot be undone.

", "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/foundation-models/{modelIdentifier}" + "code": 202, + "method": "DELETE", + "uri": "/automated-reasoning-policies/{policyArn}" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#GetFoundationModelAvailability": { + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyBuildWorkflow": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetFoundationModelAvailabilityRequest" + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyBuildWorkflowRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetFoundationModelAvailabilityResponse" + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyBuildWorkflowResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, @@ -5884,81 +6636,66 @@ } ], "traits": { - "smithy.api#documentation": "

Get information about the Foundation model availability.

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

Deletes an Automated Reasoning policy build workflow and its associated artifacts. This permanently removes the workflow history and any generated assets.

", "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/foundation-model-availability/{modelId}" + "code": 202, + "method": "DELETE", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#GetFoundationModelAvailabilityRequest": { + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyBuildWorkflowRequest": { "type": "structure", "members": { - "modelId": { - "target": "com.amazonaws.bedrock#BedrockModelId", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

The model Id of the foundation model.

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

The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#GetFoundationModelAvailabilityResponse": { - "type": "structure", - "members": { - "modelId": { - "target": "com.amazonaws.bedrock#BedrockModelId", - "traits": { - "smithy.api#documentation": "

The model Id of the foundation model.

", - "smithy.api#required": {} - } - }, - "agreementAvailability": { - "target": "com.amazonaws.bedrock#AgreementAvailability", - "traits": { - "smithy.api#documentation": "

Agreement availability.

", - "smithy.api#required": {} - } - }, - "authorizationStatus": { - "target": "com.amazonaws.bedrock#AuthorizationStatus", - "traits": { - "smithy.api#documentation": "

Authorization status.

", - "smithy.api#required": {} - } }, - "entitlementAvailability": { - "target": "com.amazonaws.bedrock#EntitlementAvailability", + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", "traits": { - "smithy.api#documentation": "

Entitlement availability.

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

The unique identifier of the build workflow to delete.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "regionAvailability": { - "target": "com.amazonaws.bedrock#RegionAvailability", + "lastUpdatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

Region availability.

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

The timestamp when the build workflow was last updated. This is used for optimistic concurrency control to prevent accidental deletion of workflows that have been modified.

", + "smithy.api#httpQuery": "updatedAt", "smithy.api#required": {} } } }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyBuildWorkflowResponse": { + "type": "structure", + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetFoundationModelRequest": { + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyRequest": { "type": "structure", "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#ModelIdentifier", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

The model identifier.

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

The Amazon Resource Name (ARN) of the Automated Reasoning policy to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5968,35 +6705,34 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GetFoundationModelResponse": { + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyResponse": { "type": "structure", - "members": { - "modelDetails": { - "target": "com.amazonaws.bedrock#FoundationModelDetails", - "traits": { - "smithy.api#documentation": "

Information about the foundation model.

" - } - } - }, + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetGuardrail": { + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyTestCase": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetGuardrailRequest" + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyTestCaseRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetGuardrailResponse" + "target": "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyTestCaseResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, + { + "target": "com.amazonaws.bedrock#ResourceInUseException" + }, { "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, @@ -6008,31 +6744,40 @@ } ], "traits": { - "smithy.api#documentation": "

Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.

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

Deletes an Automated Reasoning policy test. This operation is idempotent; if you delete a test more than once, each call succeeds.

", "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/guardrails/{guardrailIdentifier}" + "code": 202, + "method": "DELETE", + "uri": "/automated-reasoning-policies/{policyArn}/test-cases/{testCaseId}" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#GetGuardrailRequest": { + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyTestCaseRequest": { "type": "structure", "members": { - "guardrailIdentifier": { - "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.

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

The Amazon Resource Name (ARN) of the Automated Reasoning policy that contains the test.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "guardrailVersion": { - "target": "com.amazonaws.bedrock#GuardrailVersion", + "testCaseId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId", "traits": { - "smithy.api#documentation": "

The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the DRAFT version.

", - "smithy.api#httpQuery": "guardrailVersion" + "smithy.api#documentation": "

The unique identifier of the test to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the test was last updated. This is used as a concurrency token to prevent conflicting modifications.

", + "smithy.api#httpQuery": "updatedAt", + "smithy.api#required": {} } } }, @@ -6040,149 +6785,66 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GetGuardrailResponse": { + "com.amazonaws.bedrock#DeleteAutomatedReasoningPolicyTestCaseResponse": { "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrock#GuardrailName", - "traits": { - "smithy.api#documentation": "

The name of the guardrail.

", - "smithy.api#required": {} - } + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteCustomModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteCustomModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteCustomModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "description": { - "target": "com.amazonaws.bedrock#GuardrailDescription", - "traits": { - "smithy.api#documentation": "

The description of the guardrail.

" - } + { + "target": "com.amazonaws.bedrock#ConflictException" }, - "guardrailId": { - "target": "com.amazonaws.bedrock#GuardrailId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail.

", - "smithy.api#required": {} - } - }, - "guardrailArn": { - "target": "com.amazonaws.bedrock#GuardrailArn", - "traits": { - "smithy.api#documentation": "

The ARN of the guardrail.

", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrock#GuardrailVersion", - "traits": { - "smithy.api#documentation": "

The version of the guardrail.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#GuardrailStatus", - "traits": { - "smithy.api#documentation": "

The status of the guardrail.

", - "smithy.api#required": {} - } - }, - "topicPolicy": { - "target": "com.amazonaws.bedrock#GuardrailTopicPolicy", - "traits": { - "smithy.api#documentation": "

The topic policy that was configured for the guardrail.

" - } - }, - "contentPolicy": { - "target": "com.amazonaws.bedrock#GuardrailContentPolicy", - "traits": { - "smithy.api#documentation": "

The content policy that was configured for the guardrail.

" - } - }, - "wordPolicy": { - "target": "com.amazonaws.bedrock#GuardrailWordPolicy", - "traits": { - "smithy.api#documentation": "

The word policy that was configured for the guardrail.

" - } - }, - "sensitiveInformationPolicy": { - "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicy", - "traits": { - "smithy.api#documentation": "

The sensitive information policy that was configured for the guardrail.

" - } - }, - "contextualGroundingPolicy": { - "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicy", - "traits": { - "smithy.api#documentation": "

The contextual grounding policy used in the guardrail.

" - } - }, - "crossRegionDetails": { - "target": "com.amazonaws.bedrock#GuardrailCrossRegionDetails", - "traits": { - "smithy.api#documentation": "

Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

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

The date and time at which the guardrail was created.

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time at which the guardrail was updated.

", - "smithy.api#required": {} - } - }, - "statusReasons": { - "target": "com.amazonaws.bedrock#GuardrailStatusReasons", - "traits": { - "smithy.api#documentation": "

Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

" - } - }, - "failureRecommendations": { - "target": "com.amazonaws.bedrock#GuardrailFailureRecommendations", - "traits": { - "smithy.api#documentation": "

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

" - } + { + "target": "com.amazonaws.bedrock#InternalServerException" }, - "blockedInputMessaging": { - "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", - "traits": { - "smithy.api#documentation": "

The message that the guardrail returns when it blocks a prompt.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, - "blockedOutputsMessaging": { - "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", - "traits": { - "smithy.api#documentation": "

The message that the guardrail returns when it blocks a model response.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.bedrock#ThrottlingException" }, - "kmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that encrypts the guardrail.

" - } + { + "target": "com.amazonaws.bedrock#ValidationException" } - }, + ], "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/custom-models/{modelIdentifier}" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#GetImportedModel": { + "com.amazonaws.bedrock#DeleteCustomModelDeployment": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetImportedModelRequest" + "target": "com.amazonaws.bedrock#DeleteCustomModelDeploymentRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetImportedModelResponse" + "target": "com.amazonaws.bedrock#DeleteCustomModelDeploymentResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, @@ -6197,22 +6859,22 @@ } ], "traits": { - "smithy.api#documentation": "

Gets properties associated with a customized model you imported.

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

Deletes a custom model deployment. This operation stops the deployment and removes it from your account. After deletion, the deployment ARN can no longer be used for inference requests.

The following actions are related to the DeleteCustomModelDeployment operation:

", "smithy.api#http": { "code": 200, - "method": "GET", - "uri": "/imported-models/{modelIdentifier}" + "method": "DELETE", + "uri": "/model-customization/custom-model-deployments/{customModelDeploymentIdentifier}" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#GetImportedModelRequest": { + "com.amazonaws.bedrock#DeleteCustomModelDeploymentRequest": { "type": "structure", "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#ImportedModelIdentifier", + "customModelDeploymentIdentifier": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentIdentifier", "traits": { - "smithy.api#documentation": "

Name or Amazon Resource Name (ARN) of the imported model.

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

The Amazon Resource Name (ARN) or name of the custom model deployment to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6222,86 +6884,51 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GetImportedModelResponse": { + "com.amazonaws.bedrock#DeleteCustomModelDeploymentResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteCustomModelRequest": { "type": "structure", "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#ImportedModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with this imported model.

" - } - }, - "modelName": { - "target": "com.amazonaws.bedrock#ImportedModelName", - "traits": { - "smithy.api#documentation": "

The name of the imported model.

" - } - }, - "jobName": { - "target": "com.amazonaws.bedrock#JobName", - "traits": { - "smithy.api#documentation": "

Job name associated with the imported model.

" - } - }, - "jobArn": { - "target": "com.amazonaws.bedrock#ModelImportJobArn", - "traits": { - "smithy.api#documentation": "

Job Amazon Resource Name (ARN) associated with the imported model.

" - } - }, - "modelDataSource": { - "target": "com.amazonaws.bedrock#ModelDataSource", - "traits": { - "smithy.api#documentation": "

The data source for this imported model.

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

Creation time of the imported model.

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

The architecture of the imported model.

" - } - }, - "modelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", - "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 converse.

" - } - }, - "customModelUnits": { - "target": "com.amazonaws.bedrock#CustomModelUnits", + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ModelIdentifier", "traits": { - "smithy.api#documentation": "

Information about the hardware utilization for a single copy of the model.

" + "smithy.api#documentation": "

Name of the model to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteCustomModelResponse": { + "type": "structure", + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetInferenceProfile": { + "com.amazonaws.bedrock#DeleteFoundationModelAgreement": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetInferenceProfileRequest" + "target": "com.amazonaws.bedrock#DeleteFoundationModelAgreementRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetInferenceProfileResponse" + "target": "com.amazonaws.bedrock#DeleteFoundationModelAgreementResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, @@ -6316,23 +6943,21 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about an inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

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

Delete the model access agreement for the specified model.

", "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/inference-profiles/{inferenceProfileIdentifier}" - }, - "smithy.api#readonly": {} + "code": 202, + "method": "POST", + "uri": "/delete-foundation-model-agreement" + } } }, - "com.amazonaws.bedrock#GetInferenceProfileRequest": { + "com.amazonaws.bedrock#DeleteFoundationModelAgreementRequest": { "type": "structure", "members": { - "inferenceProfileIdentifier": { - "target": "com.amazonaws.bedrock#InferenceProfileIdentifier", + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", "traits": { - "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the inference profile.

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

Model Id of the model access to delete.

", "smithy.api#required": {} } } @@ -6341,86 +6966,96 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GetInferenceProfileResponse": { + "com.amazonaws.bedrock#DeleteFoundationModelAgreementResponse": { "type": "structure", - "members": { - "inferenceProfileName": { - "target": "com.amazonaws.bedrock#InferenceProfileName", - "traits": { - "smithy.api#documentation": "

The name of the inference profile.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrock#InferenceProfileDescription", - "traits": { - "smithy.api#documentation": "

The description of the inference profile.

" - } + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteGuardrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "createdAt": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the inference profile was created.

" - } + { + "target": "com.amazonaws.bedrock#ConflictException" }, - "updatedAt": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the inference profile was last updated.

" - } + { + "target": "com.amazonaws.bedrock#InternalServerException" }, - "inferenceProfileArn": { - "target": "com.amazonaws.bedrock#InferenceProfileArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference profile.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, - "models": { - "target": "com.amazonaws.bedrock#InferenceProfileModels", - "traits": { - "smithy.api#documentation": "

A list of information about each model in the inference profile.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.bedrock#ThrottlingException" }, - "inferenceProfileId": { - "target": "com.amazonaws.bedrock#InferenceProfileId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the inference profile.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a guardrail.

  • To delete a guardrail, only specify the ARN of the guardrail in the guardrailIdentifier field. If you delete a guardrail, all of its versions will be deleted.

  • To delete a version of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field and the version in the guardrailVersion field.

", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/guardrails/{guardrailIdentifier}" }, - "status": { - "target": "com.amazonaws.bedrock#InferenceProfileStatus", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteGuardrailRequest": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", "traits": { - "smithy.api#documentation": "

The status of the inference profile. ACTIVE means that the inference profile is ready to be used.

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

The unique identifier of the guardrail. This can be an ID or the ARN.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.bedrock#InferenceProfileType", + "guardrailVersion": { + "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", "traits": { - "smithy.api#documentation": "

The type of the inference profile. The following types are possible:

  • SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.

  • APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.

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

The version of the guardrail.

", + "smithy.api#httpQuery": "guardrailVersion" } } }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteGuardrailResponse": { + "type": "structure", + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetMarketplaceModelEndpoint": { + "com.amazonaws.bedrock#DeleteImportedModel": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetMarketplaceModelEndpointRequest" + "target": "com.amazonaws.bedrock#DeleteImportedModelRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetMarketplaceModelEndpointResponse" + "target": "com.amazonaws.bedrock#DeleteImportedModelResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, @@ -6435,22 +7070,22 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.

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

Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.

", "smithy.api#http": { "code": 200, - "method": "GET", - "uri": "/marketplace-model/endpoints/{endpointArn}" + "method": "DELETE", + "uri": "/imported-models/{modelIdentifier}" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#GetMarketplaceModelEndpointRequest": { + "com.amazonaws.bedrock#DeleteImportedModelRequest": { "type": "structure", "members": { - "endpointArn": { - "target": "com.amazonaws.bedrock#Arn", + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ImportedModelIdentifier", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint you want to get information about.

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

Name of the imported model to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6460,32 +7095,28 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GetMarketplaceModelEndpointResponse": { + "com.amazonaws.bedrock#DeleteImportedModelResponse": { "type": "structure", - "members": { - "marketplaceModelEndpoint": { - "target": "com.amazonaws.bedrock#MarketplaceModelEndpoint", - "traits": { - "smithy.api#documentation": "

Details about the requested endpoint.

" - } - } - }, + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetModelCopyJob": { + "com.amazonaws.bedrock#DeleteInferenceProfile": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetModelCopyJobRequest" + "target": "com.amazonaws.bedrock#DeleteInferenceProfileRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetModelCopyJobResponse" + "target": "com.amazonaws.bedrock#DeleteInferenceProfileResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, @@ -6500,22 +7131,22 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

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

Deletes an application inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

", "smithy.api#http": { "code": 200, - "method": "GET", - "uri": "/model-copy-jobs/{jobArn}" + "method": "DELETE", + "uri": "/inference-profiles/{inferenceProfileIdentifier}" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#GetModelCopyJobRequest": { + "com.amazonaws.bedrock#DeleteInferenceProfileRequest": { "type": "structure", "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "inferenceProfileIdentifier": { + "target": "com.amazonaws.bedrock#InferenceProfileIdentifier", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model copy job.

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

The Amazon Resource Name (ARN) or ID of the application inference profile to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6525,93 +7156,20 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GetModelCopyJobResponse": { + "com.amazonaws.bedrock#DeleteInferenceProfileResponse": { "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCopyJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model copy job.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#ModelCopyJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the model copy job.

", - "smithy.api#required": {} - } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the model copy job was created.

", - "smithy.api#required": {} - } - }, - "targetModelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the copied model.

", - "smithy.api#required": {} - } - }, - "targetModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

The name of the copied model.

" - } - }, - "sourceAccountId": { - "target": "com.amazonaws.bedrock#AccountId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the account that the model being copied originated from.

", - "smithy.api#required": {} - } - }, - "sourceModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the original model being copied.

", - "smithy.api#required": {} - } - }, - "targetModelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key encrypting the copied model.

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

The tags associated with the copied model.

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

An error message for why the model copy job failed.

" - } - }, - "sourceModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

The name of the original model being copied.

" - } - } - }, + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetModelCustomizationJob": { + "com.amazonaws.bedrock#DeleteMarketplaceModelEndpoint": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetModelCustomizationJobRequest" + "target": "com.amazonaws.bedrock#DeleteMarketplaceModelEndpointRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetModelCustomizationJobResponse" + "target": "com.amazonaws.bedrock#DeleteMarketplaceModelEndpointResponse" }, "errors": [ { @@ -6631,22 +7189,22 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Amazon Bedrock User Guide.

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

Deletes an endpoint for a model from Amazon Bedrock Marketplace.

", "smithy.api#http": { "code": 200, - "method": "GET", - "uri": "/model-customization-jobs/{jobIdentifier}" + "method": "DELETE", + "uri": "/marketplace-model/endpoints/{endpointArn}" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#GetModelCustomizationJobRequest": { + "com.amazonaws.bedrock#DeleteMarketplaceModelEndpointRequest": { "type": "structure", "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobIdentifier", + "endpointArn": { + "target": "com.amazonaws.bedrock#Arn", "traits": { - "smithy.api#documentation": "

Identifier for the customization job.

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

The Amazon Resource Name (ARN) of the endpoint you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6656,168 +7214,63 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GetModelCustomizationJobResponse": { + "com.amazonaws.bedrock#DeleteMarketplaceModelEndpointResponse": { "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customization job.

", - "smithy.api#required": {} - } - }, - "jobName": { - "target": "com.amazonaws.bedrock#JobName", - "traits": { - "smithy.api#documentation": "

The name of the customization job.

", - "smithy.api#required": {} - } - }, - "outputModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

The name of the output model.

", - "smithy.api#required": {} - } - }, - "outputModelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the output model.

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

The token that you specified in the CreateCustomizationJob request.

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

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

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed.

" - } - }, - "statusDetails": { - "target": "com.amazonaws.bedrock#StatusDetails", - "traits": { - "smithy.api#documentation": "

For a Distillation job, the details about the statuses of the sub-tasks of the customization job.

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

Information about why the job failed.

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

Time that the resource was created.

", - "smithy.api#required": {} - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Time that the resource was last modified.

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

Time that the resource transitioned to terminal state.

" - } - }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the base model.

", - "smithy.api#required": {} - } - }, - "hyperParameters": { - "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", - "traits": { - "smithy.api#documentation": "

The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.

" - } - }, - "trainingDataConfig": { - "target": "com.amazonaws.bedrock#TrainingDataConfig", - "traits": { - "smithy.api#documentation": "

Contains information about the training dataset.

", - "smithy.api#required": {} - } - }, - "validationDataConfig": { - "target": "com.amazonaws.bedrock#ValidationDataConfig", - "traits": { - "smithy.api#documentation": "

Contains information about the validation dataset.

", - "smithy.api#required": {} - } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#OutputDataConfig", - "traits": { - "smithy.api#documentation": "

Output data configuration

", - "smithy.api#required": {} - } - }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", - "traits": { - "smithy.api#documentation": "

The type of model customization.

" - } - }, - "outputModelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" - } - }, - "trainingMetrics": { - "target": "com.amazonaws.bedrock#TrainingMetrics", - "traits": { - "smithy.api#documentation": "

Contains training metrics from the job creation.

" - } - }, - "validationMetrics": { - "target": "com.amazonaws.bedrock#ValidationMetrics", - "traits": { - "smithy.api#documentation": "

The loss metric for each validator that you provided in the createjob request.

" - } + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "vpcConfig": { - "target": "com.amazonaws.bedrock#VpcConfig", - "traits": { - "smithy.api#documentation": "

VPC configuration for the custom model job.

" - } + { + "target": "com.amazonaws.bedrock#InternalServerException" }, - "customizationConfig": { - "target": "com.amazonaws.bedrock#CustomizationConfig", - "traits": { - "smithy.api#documentation": "

The customization configuration for the model customization job.

" - } + { + "target": "com.amazonaws.bedrock#ThrottlingException" } - }, + ], + "traits": { + "smithy.api#documentation": "

Delete the invocation logging.

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/logging/modelinvocations" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse": { + "type": "structure", + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetModelImportJob": { + "com.amazonaws.bedrock#DeletePromptRouter": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetModelImportJobRequest" + "target": "com.amazonaws.bedrock#DeletePromptRouterRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetModelImportJobResponse" + "target": "com.amazonaws.bedrock#DeletePromptRouterResponse" }, "errors": [ { @@ -6837,22 +7290,22 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the properties associated with import model job, including the status of the job. For more information, see Import a customized model in the Amazon Bedrock User Guide.

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

Deletes a specified prompt router. This action cannot be undone.

", "smithy.api#http": { "code": 200, - "method": "GET", - "uri": "/model-import-jobs/{jobIdentifier}" + "method": "DELETE", + "uri": "/prompt-routers/{promptRouterArn}" }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#GetModelImportJobRequest": { + "com.amazonaws.bedrock#DeletePromptRouterRequest": { "type": "structure", "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#ModelImportJobIdentifier", + "promptRouterArn": { + "target": "com.amazonaws.bedrock#PromptRouterArn", "traits": { - "smithy.api#documentation": "

The identifier of the import job.

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

The Amazon Resource Name (ARN) of the prompt router to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6862,99 +7315,81 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GetModelImportJobResponse": { + "com.amazonaws.bedrock#DeletePromptRouterResponse": { "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelImportJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the import job.

" - } + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "jobName": { - "target": "com.amazonaws.bedrock#JobName", - "traits": { - "smithy.api#documentation": "

The name of the import job.

" - } + { + "target": "com.amazonaws.bedrock#ConflictException" }, - "importedModelName": { - "target": "com.amazonaws.bedrock#ImportedModelName", - "traits": { - "smithy.api#documentation": "

The name of the imported model.

" - } + { + "target": "com.amazonaws.bedrock#InternalServerException" }, - "importedModelArn": { - "target": "com.amazonaws.bedrock#ImportedModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the imported model.

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

The Amazon Resource Name (ARN) of the IAM role associated with this job.

" - } - }, - "modelDataSource": { - "target": "com.amazonaws.bedrock#ModelDataSource", - "traits": { - "smithy.api#documentation": "

The data source for the imported model.

" - } - }, - "status": { - "target": "com.amazonaws.bedrock#ModelImportJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the job. A successful job transitions from in-progress to completed when the imported model is ready to use. If the job failed, the failure message contains information about why the job failed.

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

Information about why the import job failed.

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

The time the resource was created.

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

Time the resource was last modified.

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

Time that the resource transitioned to terminal state.

" - } + { + "target": "com.amazonaws.bedrock#ThrottlingException" }, - "vpcConfig": { - "target": "com.amazonaws.bedrock#VpcConfig", - "traits": { - "smithy.api#documentation": "

The Virtual Private Cloud (VPC) configuration of the import model job.

" - } + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/provisioned-model-throughput/{provisionedModelId}" }, - "importedModelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "provisionedModelId": { + "target": "com.amazonaws.bedrock#ProvisionedModelId", "traits": { - "smithy.api#documentation": "

The imported model is encrypted at rest using this key.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the Provisioned Throughput.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse": { + "type": "structure", + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#GetModelInvocationJob": { + "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpoint": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#GetModelInvocationJobRequest" + "target": "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpointRequest" }, "output": { - "target": "com.amazonaws.bedrock#GetModelInvocationJobResponse" + "target": "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpointResponse" }, "errors": [ { @@ -6966,6 +7401,9 @@ { "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, + { + "target": "com.amazonaws.bedrock#ServiceUnavailableException" + }, { "target": "com.amazonaws.bedrock#ThrottlingException" }, @@ -6974,22 +7412,21 @@ } ], "traits": { - "smithy.api#documentation": "

Gets details about a batch inference job. For more information, see Monitor batch inference jobs

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

Deregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint.

", "smithy.api#http": { "code": 200, - "method": "GET", - "uri": "/model-invocation-job/{jobIdentifier}" - }, - "smithy.api#readonly": {} + "method": "DELETE", + "uri": "/marketplace-model/endpoints/{endpointArn}/registration" + } } }, - "com.amazonaws.bedrock#GetModelInvocationJobRequest": { + "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpointRequest": { "type": "structure", "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#ModelInvocationJobIdentifier", + "endpointArn": { + "target": "com.amazonaws.bedrock#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

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

The Amazon Resource Name (ARN) of the endpoint you want to deregister.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6999,263 +7436,4001 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#GetModelInvocationJobResponse": { + "com.amazonaws.bedrock#DeregisterMarketplaceModelEndpointResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DimensionalPriceRate": { "type": "structure", "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelInvocationJobArn", + "dimension": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

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

Dimension for the price rate.

" } }, - "jobName": { - "target": "com.amazonaws.bedrock#ModelInvocationJobName", + "price": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the batch inference job.

" + "smithy.api#documentation": "

Single-dimensional rate information.

" } }, - "modelId": { - "target": "com.amazonaws.bedrock#ModelId", + "description": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique identifier of the foundation model used for model inference.

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

Description of the price rate.

" } }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", + "unit": { + "target": "smithy.api#String", "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" + "smithy.api#documentation": "

Unit associated with the price.

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

Dimensional price rate.

" + } + }, + "com.amazonaws.bedrock#DistillationConfig": { + "type": "structure", + "members": { + "teacherModelConfig": { + "target": "com.amazonaws.bedrock#TeacherModelConfig", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

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

The teacher model configuration.

", "smithy.api#required": {} } - }, - "status": { - "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", + } + }, + "traits": { + "smithy.api#documentation": "

Settings for distilling a foundation model into a smaller and more efficient model.

" + } + }, + "com.amazonaws.bedrock#EndpointConfig": { + "type": "union", + "members": { + "sageMaker": { + "target": "com.amazonaws.bedrock#SageMakerEndpoint", "traits": { - "smithy.api#documentation": "

The status of the batch inference job.

The following statuses are possible:

  • Submitted – This job has been submitted to a queue for validation.

  • Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:

    • Your IAM service role has access to the Amazon S3 buckets containing your files.

    • Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the modelInput value matches the request body for the model.

    • Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.

  • Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.

  • Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.

  • InProgress – This job has begun. You can start viewing the results in the output S3 location.

  • Completed – This job has successfully completed. View the output files in the output S3 location.

  • PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.

  • Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.

  • Stopped – This job was stopped by a user.

  • Stopping – This job is being stopped by a user.

" + "smithy.api#documentation": "

The configuration specific to Amazon SageMaker for the endpoint.

" } - }, - "message": { - "target": "com.amazonaws.bedrock#Message", + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the configuration for the endpoint.

" + } + }, + "com.amazonaws.bedrock#EndpointName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.bedrock#EntitlementAvailability": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

If the batch inference job failed, this field contains a message describing why the job failed.

" + "smithy.api#enumValue": "AVAILABLE" } }, - "submitTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "NOT_AVAILABLE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The time at which the batch inference job was submitted.

", - "smithy.api#required": {} + "smithy.api#enumValue": "NOT_AVAILABLE" } - }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", + } + } + }, + "com.amazonaws.bedrock#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrock#ErrorMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ErrorMessage" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.bedrock#EvaluationBedrockKnowledgeBaseIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#KnowledgeBaseId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#EvaluationBedrockModel": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationBedrockModelIdentifier", "traits": { - "smithy.api#documentation": "

The time at which the batch inference job was last modified.

" + "smithy.api#documentation": "

The ARN of the Amazon Bedrock model or inference profile specified.

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

The time at which the batch inference job ended.

" - } - }, - "inputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", - "traits": { - "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

", - "smithy.api#required": {} - } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", - "traits": { - "smithy.api#documentation": "

Details about the location of the output of the batch inference job.

", - "smithy.api#required": {} - } - }, - "vpcConfig": { - "target": "com.amazonaws.bedrock#VpcConfig", - "traits": { - "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

" - } - }, - "timeoutDurationInHours": { - "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", + "inferenceParams": { + "target": "com.amazonaws.bedrock#EvaluationModelInferenceParams", "traits": { - "smithy.api#documentation": "

The number of hours after which batch inference job was set to time out.

" + "smithy.api#addedDefault": {}, + "smithy.api#default": "{}", + "smithy.api#documentation": "

Each Amazon Bedrock support different inference parameters that change how the model behaves during inference.

" } }, - "jobExpirationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "performanceConfig": { + "target": "com.amazonaws.bedrock#PerformanceConfiguration", "traits": { - "smithy.api#documentation": "

The time at which the batch inference job times or timed out.

" + "smithy.api#documentation": "

Specifies performance settings for the model or inference profile.

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

Contains the ARN of the Amazon Bedrock model or inference profile specified in your 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.

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#GetModelInvocationLoggingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - } - ], + "com.amazonaws.bedrock#EvaluationBedrockModelIdentifier": { + "type": "string", "traits": { - "smithy.api#documentation": "

Get the current configuration values for model invocation logging.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/logging/modelinvocations" + "smithy.api#length": { + "min": 1, + "max": 2048 }, - "smithy.api#readonly": {} + "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}:application-inference-profile/[a-z0-9]{12})|([0-9]{12}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([0-9]{12}:(default-prompt-router|prompt-router)/[a-zA-Z0-9-:.]+)))|(([a-z]{2,4}[.]{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}))|arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:endpoint/[a-z0-9-]{1,63}$" } }, - "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest": { - "type": "structure", - "members": {}, + "com.amazonaws.bedrock#EvaluationBedrockModelIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationBedrockModelIdentifier" + }, "traits": { - "smithy.api#input": {} + "smithy.api#length": { + "min": 0, + "max": 2 + } } }, - "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse": { - "type": "structure", + "com.amazonaws.bedrock#EvaluationConfig": { + "type": "union", "members": { - "loggingConfig": { - "target": "com.amazonaws.bedrock#LoggingConfig", + "automated": { + "target": "com.amazonaws.bedrock#AutomatedEvaluationConfig", "traits": { - "smithy.api#documentation": "

The current configuration values.

" + "smithy.api#documentation": "

Contains the configuration details of an automated evaluation job that computes metrics.

" + } + }, + "human": { + "target": "com.amazonaws.bedrock#HumanEvaluationConfig", + "traits": { + "smithy.api#documentation": "

Contains the configuration details of an evaluation job that uses human workers.

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

The configuration details of either an automated or human-based evaluation job.

" } }, - "com.amazonaws.bedrock#GetPromptRouter": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetPromptRouterRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetPromptRouterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" + "com.amazonaws.bedrock#EvaluationDataset": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#EvaluationDatasetName", + "traits": { + "smithy.api#documentation": "

Used to specify supported built-in prompt datasets. Valid values are Builtin.Bold, Builtin.BoolQ, Builtin.NaturalQuestions, Builtin.Gigaword, Builtin.RealToxicityPrompts, Builtin.TriviaQA, Builtin.T-Rex, Builtin.WomensEcommerceClothingReviews and Builtin.Wikitext2.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ValidationException" + "datasetLocation": { + "target": "com.amazonaws.bedrock#EvaluationDatasetLocation", + "traits": { + "smithy.api#documentation": "

For custom prompt datasets, you must specify the location in Amazon S3 where the prompt dataset is saved.

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

Retrieves details about a prompt router.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/prompt-routers/{promptRouterArn}" - }, - "smithy.api#readonly": {} + "smithy.api#documentation": "

Used to specify the name of a built-in prompt dataset and optionally, the Amazon S3 bucket where a custom prompt dataset is saved.

" } }, - "com.amazonaws.bedrock#GetPromptRouterRequest": { - "type": "structure", + "com.amazonaws.bedrock#EvaluationDatasetLocation": { + "type": "union", "members": { - "promptRouterArn": { - "target": "com.amazonaws.bedrock#PromptRouterArn", + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", "traits": { - "smithy.api#documentation": "

The prompt router's ARN

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

The S3 URI of the S3 bucket specified in the job.

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

The location in Amazon S3 where your prompt dataset is stored.

" } }, - "com.amazonaws.bedrock#GetPromptRouterResponse": { + "com.amazonaws.bedrock#EvaluationDatasetMetricConfig": { "type": "structure", "members": { - "promptRouterName": { - "target": "com.amazonaws.bedrock#PromptRouterName", + "taskType": { + "target": "com.amazonaws.bedrock#EvaluationTaskType", "traits": { - "smithy.api#documentation": "

The router's name.

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

The the type of task you want to evaluate for your evaluation job. This applies only to model evaluation jobs and is ignored for knowledge base evaluation jobs.

", "smithy.api#required": {} } }, - "routingCriteria": { - "target": "com.amazonaws.bedrock#RoutingCriteria", + "dataset": { + "target": "com.amazonaws.bedrock#EvaluationDataset", "traits": { - "smithy.api#documentation": "

The router's routing criteria.

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

Specifies the prompt dataset.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.bedrock#PromptRouterDescription", + "metricNames": { + "target": "com.amazonaws.bedrock#EvaluationMetricNames", "traits": { - "smithy.api#documentation": "

The router's description.

" + "smithy.api#documentation": "

The names of the metrics you want to use for your evaluation job.

For knowledge base evaluation jobs that evaluate retrieval only, valid values are \"Builtin.ContextRelevance\", \"Builtin.ContextCoverage\".

For knowledge base evaluation jobs that evaluate retrieval with response generation, valid values are \"Builtin.Correctness\", \"Builtin.Completeness\", \"Builtin.Helpfulness\", \"Builtin.LogicalCoherence\", \"Builtin.Faithfulness\", \"Builtin.Harmfulness\", \"Builtin.Stereotyping\", \"Builtin.Refusal\".

For automated model evaluation jobs, valid values are \"Builtin.Accuracy\", \"Builtin.Robustness\", and \"Builtin.Toxicity\". In model evaluation jobs that use a LLM as judge you can specify \"Builtin.Correctness\", \"Builtin.Completeness\", \"Builtin.Faithfulness\", \"Builtin.Helpfulness\", \"Builtin.Coherence\", \"Builtin.Relevance\", \"Builtin.FollowingInstructions\", \"Builtin.ProfessionalStyleAndTone\", You can also specify the following responsible AI related metrics only for model evaluation job that use a LLM as judge \"Builtin.Harmfulness\", \"Builtin.Stereotyping\", and \"Builtin.Refusal\".

For human-based model evaluation jobs, the list of strings must match the name parameter specified in HumanEvaluationCustomMetric.

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

Defines the prompt datasets, built-in metric names and custom metric names, and the task type.

" + } + }, + "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#EvaluationDatasetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 }, - "createdAt": { - "target": "com.amazonaws.bedrock#Timestamp", + "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationInferenceConfig": { + "type": "union", + "members": { + "models": { + "target": "com.amazonaws.bedrock#EvaluationModelConfigs", "traits": { - "smithy.api#documentation": "

When the router was created.

" + "smithy.api#documentation": "

Specifies the inference models.

" } }, - "updatedAt": { - "target": "com.amazonaws.bedrock#Timestamp", + "ragConfigs": { + "target": "com.amazonaws.bedrock#RagConfigs", "traits": { - "smithy.api#documentation": "

When the router was updated.

" + "smithy.api#documentation": "

Contains the configuration details of the inference for a knowledge base evaluation job, including either the retrieval only configuration or the retrieval with response generation configuration.

" } - }, - "promptRouterArn": { - "target": "com.amazonaws.bedrock#PromptRouterArn", + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details of the inference model for an evaluation job.

For automated model evaluation jobs, only a single model is supported.

For human-based model evaluation jobs, your annotator can compare the responses for up to two different models.

" + } + }, + "com.amazonaws.bedrock#EvaluationInferenceConfigSummary": { + "type": "structure", + "members": { + "modelConfigSummary": { + "target": "com.amazonaws.bedrock#EvaluationModelConfigSummary", "traits": { - "smithy.api#documentation": "

The prompt router's ARN

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

A summary of the models used in an Amazon Bedrock model evaluation job. These resources can be models in Amazon Bedrock or models outside of Amazon Bedrock that you use to generate your own inference response data.

" } }, - "models": { - "target": "com.amazonaws.bedrock#PromptRouterTargetModels", + "ragConfigSummary": { + "target": "com.amazonaws.bedrock#EvaluationRagConfigSummary", "traits": { - "smithy.api#documentation": "

The router's models.

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

A summary of the RAG resources used in an Amazon Bedrock Knowledge Base evaluation job. These resources can be Knowledge Bases in Amazon Bedrock or RAG sources outside of Amazon Bedrock that you use to generate your own inference response data.

" } - }, - "fallbackModel": { - "target": "com.amazonaws.bedrock#PromptRouterTargetModel", - "traits": { + } + }, + "traits": { + "smithy.api#documentation": "

Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.

" + } + }, + "com.amazonaws.bedrock#EvaluationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#EvaluationJobDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationJobIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bedrock#EvaluationJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9](-*[a-z0-9]){0,62}$" + } + }, + "com.amazonaws.bedrock#EvaluationJobResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJob" + }, + { + "target": "com.amazonaws.bedrock#CreateEvaluationJob" + }, + { + "target": "com.amazonaws.bedrock#GetEvaluationJob" + }, + { + "target": "com.amazonaws.bedrock#ListEvaluationJobs" + }, + { + "target": "com.amazonaws.bedrock#StopEvaluationJob" + } + ] + }, + "com.amazonaws.bedrock#EvaluationJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "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" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.bedrock#EvaluationJobType": { + "type": "enum", + "members": { + "HUMAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Human" + } + }, + "AUTOMATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Automated" + } + } + } + }, + "com.amazonaws.bedrock#EvaluationMetricDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^.+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationMetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationMetricNames": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationMetricName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bedrock#EvaluationModelConfig": { + "type": "union", + "members": { + "bedrockModel": { + "target": "com.amazonaws.bedrock#EvaluationBedrockModel", + "traits": { + "smithy.api#documentation": "

Defines the Amazon Bedrock model or inference profile and inference parameters you want used.

" + } + }, + "precomputedInferenceSource": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSource", + "traits": { + "smithy.api#documentation": "

Defines the model used to generate inference response data for a model evaluation job where you provide your own inference response data.

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

Defines the models used in the model evaluation job.

" + } + }, + "com.amazonaws.bedrock#EvaluationModelConfigSummary": { + "type": "structure", + "members": { + "bedrockModelIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationBedrockModelIdentifiers", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the models used for the evaluation job.

" + } + }, + "precomputedInferenceSourceIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifiers", + "traits": { + "smithy.api#documentation": "

A label that identifies the models used for a model evaluation job where you provide your own inference response data.

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

A summary of the models used in an Amazon Bedrock model evaluation job. These resources can be models in Amazon Bedrock or models outside of Amazon Bedrock that you use to generate your own inference response data.

" + } + }, + "com.amazonaws.bedrock#EvaluationModelConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationModelConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrock#EvaluationModelInferenceParams": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1023 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationOutputDataConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI where the results of the evaluation job are saved.

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

The Amazon S3 location where the results of your evaluation job are saved.

" + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSource": { + "type": "structure", + "members": { + "inferenceSourceIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifier", + "traits": { + "smithy.api#documentation": "

A label that identifies a model used in a model evaluation job where you provide your own inference response data.

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

A summary of a model used for a model evaluation job where you provide your own inference response data.

" + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([a-zA-Z0-9._-]){0,255}$" + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedInferenceSourceIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceConfig": { + "type": "union", + "members": { + "retrieveSourceConfig": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRetrieveSourceConfig", + "traits": { + "smithy.api#documentation": "

A summary of a RAG source used for a retrieve-only Knowledge Base evaluation job where you provide your own inference response data.

" + } + }, + "retrieveAndGenerateSourceConfig": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRetrieveAndGenerateSourceConfig", + "traits": { + "smithy.api#documentation": "

A summary of a RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.

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

A summary of a RAG source used for a Knowledge Base evaluation job where you provide your own inference response data.

" + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]([a-zA-Z0-9._-]){0,255}$" + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedRetrieveAndGenerateSourceConfig": { + "type": "structure", + "members": { + "ragSourceIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifier", + "traits": { + "smithy.api#documentation": "

A label that identifies the RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.

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

A summary of a RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.

" + } + }, + "com.amazonaws.bedrock#EvaluationPrecomputedRetrieveSourceConfig": { + "type": "structure", + "members": { + "ragSourceIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifier", + "traits": { + "smithy.api#documentation": "

A label that identifies the RAG source used for a retrieve-only Knowledge Base evaluation job where you provide your own inference response data.

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

A summary of a RAG source used for a retrieve-only Knowledge Base evaluation job where you provide your own inference response data.

" + } + }, + "com.amazonaws.bedrock#EvaluationRagConfigSummary": { + "type": "structure", + "members": { + "bedrockKnowledgeBaseIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationBedrockKnowledgeBaseIdentifiers", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Knowledge Base resources used for a Knowledge Base evaluation job where Amazon Bedrock invokes the Knowledge Base for you.

" + } + }, + "precomputedRagSourceIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceIdentifiers", + "traits": { + "smithy.api#documentation": "

A label that identifies the RAG sources used for a Knowledge Base evaluation job where you provide your own inference response data.

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

A summary of the RAG resources used in an Amazon Bedrock Knowledge Base evaluation job. These resources can be Knowledge Bases in Amazon Bedrock or RAG sources outside of Amazon Bedrock that you use to generate your own inference response data.

" + } + }, + "com.amazonaws.bedrock#EvaluationRatingMethod": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_]+$" + } + }, + "com.amazonaws.bedrock#EvaluationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationSummary" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#EvaluationSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#EvaluationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the evaluation job.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#EvaluationJobName", + "traits": { + "smithy.api#documentation": "

The name for the evaluation job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the evaluation job.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the evaluation job was created.

", + "smithy.api#required": {} + } + }, + "jobType": { + "target": "com.amazonaws.bedrock#EvaluationJobType", + "traits": { + "smithy.api#documentation": "

Specifies whether the evaluation job is automated or human-based.

", + "smithy.api#required": {} + } + }, + "evaluationTaskTypes": { + "target": "com.amazonaws.bedrock#EvaluationTaskTypes", + "traits": { + "smithy.api#documentation": "

The type of task for model evaluation.

", + "smithy.api#required": {} + } + }, + "modelIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationBedrockModelIdentifiers", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": [], + "smithy.api#deprecated": { + "since": "2025-03-07", + "message": "Inference identifiers should be retrieved from the inferenceConfigSummary" + }, + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.

" + } + }, + "ragIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationBedrockKnowledgeBaseIdentifiers", + "traits": { + "smithy.api#deprecated": { + "since": "2025-03-07", + "message": "Inference identifiers should be retrieved from the inferenceConfigSummary" + }, + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.

" + } + }, + "evaluatorModelIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluatorModelIdentifiers", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.

" + } + }, + "customMetricsEvaluatorModelIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluatorModelIdentifiers", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.

" + } + }, + "inferenceConfigSummary": { + "target": "com.amazonaws.bedrock#EvaluationInferenceConfigSummary", + "traits": { + "smithy.api#documentation": "

Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.

" + } + }, + "applicationType": { + "target": "com.amazonaws.bedrock#ApplicationType", + "traits": { + "smithy.api#documentation": "

Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

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

Summary information of an evaluation job.

" + } + }, + "com.amazonaws.bedrock#EvaluationTaskType": { + "type": "enum", + "members": { + "SUMMARIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Summarization" + } + }, + "CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Classification" + } + }, + "QUESTION_AND_ANSWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QuestionAndAnswer" + } + }, + "GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Generation" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Custom" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+$" + } + }, + "com.amazonaws.bedrock#EvaluationTaskTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationTaskType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#EvaluatorModelConfig": { + "type": "union", + "members": { + "bedrockEvaluatorModels": { + "target": "com.amazonaws.bedrock#BedrockEvaluatorModels", + "traits": { + "smithy.api#documentation": "

The evaluator model used in knowledge base evaluation job or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

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

Specifies the model configuration for the evaluator model. EvaluatorModelConfig is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

" + } + }, + "com.amazonaws.bedrock#EvaluatorModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "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}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))))$|(^[a-z0-9-]+[.][a-z0-9-]+([.][a-z0-9-]+)*(:[a-z0-9-]+)?$)|^[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)$" + } + }, + "com.amazonaws.bedrock#EvaluatorModelIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluatorModelIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#ExportAutomatedReasoningPolicyVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ExportAutomatedReasoningPolicyVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ExportAutomatedReasoningPolicyVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Exports the policy definition for an Automated Reasoning policy version. Returns the complete policy definition including rules, variables, and custom variable types in a structured format.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/export" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ExportAutomatedReasoningPolicyVersionRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy to export. Can be either the unversioned ARN for the draft policy or a versioned ARN for a specific policy version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ExportAutomatedReasoningPolicyVersionResponse": { + "type": "structure", + "members": { + "policyDefinition": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition", + "traits": { + "smithy.api#documentation": "

The exported policy definition containing the formal logic rules, variables, and custom variable types.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ExternalSource": { + "type": "structure", + "members": { + "sourceType": { + "target": "com.amazonaws.bedrock#ExternalSourceType", + "traits": { + "smithy.api#documentation": "

The source type of the external source wrapper object.

", + "smithy.api#required": {} + } + }, + "s3Location": { + "target": "com.amazonaws.bedrock#S3ObjectDoc", + "traits": { + "smithy.api#documentation": "

The S3 location of the external source wrapper object.

" + } + }, + "byteContent": { + "target": "com.amazonaws.bedrock#ByteContentDoc", + "traits": { + "smithy.api#documentation": "

The identifier, content type, and data of the external source wrapper object.

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

The unique external source of the content contained in the wrapper object.

" + } + }, + "com.amazonaws.bedrock#ExternalSourceType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "BYTE_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BYTE_CONTENT" + } + } + } + }, + "com.amazonaws.bedrock#ExternalSources": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ExternalSource" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#ExternalSourcesGenerationConfiguration": { + "type": "structure", + "members": { + "promptTemplate": { + "target": "com.amazonaws.bedrock#PromptTemplate", + "traits": { + "smithy.api#documentation": "

Contains the template for the prompt for the external source wrapper object.

" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrock#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration details for the guardrail.

" + } + }, + "kbInferenceConfig": { + "target": "com.amazonaws.bedrock#KbInferenceConfig", + "traits": { + "smithy.api#documentation": "

Configuration details for inference when using RetrieveAndGenerate to generate responses while using an external source.

" + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrock#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "

Additional model parameters and their corresponding values not included in the text inference configuration for an external source. Takes in custom model parameters specific to the language model being used.

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

The response generation configuration of the external source wrapper object.

" + } + }, + "com.amazonaws.bedrock#ExternalSourcesRetrieveAndGenerateConfiguration": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#BedrockModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the foundation model or inference profile used to generate responses.

", + "smithy.api#required": {} + } + }, + "sources": { + "target": "com.amazonaws.bedrock#ExternalSources", + "traits": { + "smithy.api#documentation": "

The document for the external source wrapper object in the retrieveAndGenerate function.

", + "smithy.api#required": {} + } + }, + "generationConfiguration": { + "target": "com.amazonaws.bedrock#ExternalSourcesGenerationConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configurations details for response generation based on retrieved text chunks.

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

The configuration of the external source wrapper object in the retrieveAndGenerate function.

" + } + }, + "com.amazonaws.bedrock#FieldForReranking": { + "type": "structure", + "members": { + "fieldName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the metadata field to be used during the reranking process.

", + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a field to be used during the reranking process in a Knowledge Base vector search. This structure identifies metadata fields that should be considered when reordering search results to improve relevance.

" + } + }, + "com.amazonaws.bedrock#FieldsForReranking": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#FieldForReranking" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#FilterAttribute": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrock#FilterKey", + "traits": { + "smithy.api#documentation": "

The name of metadata attribute/field, which must match the name in your data source/document metadata.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrock#FilterValue", + "traits": { + "smithy.api#documentation": "

The value of the metadata attribute/field.

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

Specifies the name of the metadata attribute/field to apply filters. You must match the name of the attribute/field in your data source/document metadata.

" + } + }, + "com.amazonaws.bedrock#FilterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.bedrock#FilterValue": { + "type": "document" + }, + "com.amazonaws.bedrock#FineTuningJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "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" + } + } + } + }, + "com.amazonaws.bedrock#FoundationModelArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$" + } + }, + "com.amazonaws.bedrock#FoundationModelDetails": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "

The model Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "

The model identifier.

", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "

The model name.

" + } + }, + "providerName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "

The model's provider name.

" + } + }, + "inputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "

The input modalities that the model supports.

" + } + }, + "outputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "

The output modalities that the model supports.

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

Indicates whether the model supports streaming.

" + } + }, + "customizationsSupported": { + "target": "com.amazonaws.bedrock#ModelCustomizationList", + "traits": { + "smithy.api#documentation": "

The customization that the model supports.

" + } + }, + "inferenceTypesSupported": { + "target": "com.amazonaws.bedrock#InferenceTypeList", + "traits": { + "smithy.api#documentation": "

The inference types that the model supports.

" + } + }, + "modelLifecycle": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "traits": { + "smithy.api#documentation": "

Contains details about whether a model version is available or deprecated

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

Information about a foundation model.

" + } + }, + "com.amazonaws.bedrock#FoundationModelLifecycle": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycleStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether a model version is available (ACTIVE) or deprecated (LEGACY.

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

Details about whether a model version is available or deprecated.

" + } + }, + "com.amazonaws.bedrock#FoundationModelLifecycleStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "LEGACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEGACY" + } + } + } + }, + "com.amazonaws.bedrock#FoundationModelSummary": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the foundation model.

", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "

The model ID of the foundation model.

", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "

The name of the model.

" + } + }, + "providerName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "

The model's provider name.

" + } + }, + "inputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "

The input modalities that the model supports.

" + } + }, + "outputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "

The output modalities that the model supports.

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

Indicates whether the model supports streaming.

" + } + }, + "customizationsSupported": { + "target": "com.amazonaws.bedrock#ModelCustomizationList", + "traits": { + "smithy.api#documentation": "

Whether the model supports fine-tuning or continual pre-training.

" + } + }, + "inferenceTypesSupported": { + "target": "com.amazonaws.bedrock#InferenceTypeList", + "traits": { + "smithy.api#documentation": "

The inference types that the model supports.

" + } + }, + "modelLifecycle": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "traits": { + "smithy.api#documentation": "

Contains details about whether a model version is available or deprecated.

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

Summary information for a foundation model.

" + } + }, + "com.amazonaws.bedrock#FoundationModelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#FoundationModelSummary" + } + }, + "com.amazonaws.bedrock#GenerationConfiguration": { + "type": "structure", + "members": { + "promptTemplate": { + "target": "com.amazonaws.bedrock#PromptTemplate", + "traits": { + "smithy.api#documentation": "

Contains the template for the prompt that's sent to the model for response generation.

" + } + }, + "guardrailConfiguration": { + "target": "com.amazonaws.bedrock#GuardrailConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configuration details for the guardrail.

" + } + }, + "kbInferenceConfig": { + "target": "com.amazonaws.bedrock#KbInferenceConfig", + "traits": { + "smithy.api#documentation": "

Contains configuration details for inference for knowledge base retrieval and response generation.

" + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrock#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows you to provide custom model parameters specific to the language model being used.

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

The configuration details for response generation based on retrieved text chunks.

" + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyAnnotations": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyAnnotationsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyAnnotationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the current annotations for an Automated Reasoning policy build workflow. Annotations contain corrections to the rules, variables and types to be applied to the policy.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/annotations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyAnnotationsRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy whose annotations you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the build workflow whose annotations you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyAnnotationsResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the Automated Reasoning policy.

", + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the build workflow.

", + "smithy.api#required": {} + } + }, + "annotations": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationList", + "traits": { + "smithy.api#documentation": "

The current set of annotations containing rules, variables, and types extracted from the source documents. These can be modified before finalizing the policy.

", + "smithy.api#required": {} + } + }, + "annotationSetHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", + "traits": { + "smithy.api#documentation": "

A hash value representing the current state of the annotations. This is used for optimistic concurrency control when updating annotations.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the annotations were last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the build workflow to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy.

", + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the build workflow.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowStatus", + "traits": { + "smithy.api#documentation": "

The current status of the build workflow (e.g., RUNNING, COMPLETED, FAILED, CANCELLED).

", + "smithy.api#required": {} + } + }, + "buildWorkflowType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowType", + "traits": { + "smithy.api#documentation": "

The type of build workflow being executed (e.g., DOCUMENT_INGESTION, POLICY_REPAIR).

", + "smithy.api#required": {} + } + }, + "documentName": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentName", + "traits": { + "smithy.api#documentation": "

The name of the source document used in the build workflow.

" + } + }, + "documentContentType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentContentType", + "traits": { + "smithy.api#documentation": "

The content type of the source document (e.g., text/plain, application/pdf).

" + } + }, + "documentDescription": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildDocumentDescription", + "traits": { + "smithy.api#documentation": "

A detailed description of the document's content and how it should be used in the policy generation process.

" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the build workflow was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the build workflow was last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResultAssets": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResultAssetsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResultAssetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the resulting assets from a completed Automated Reasoning policy build workflow, including build logs, quality reports, and generated policy artifacts.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/result-assets" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResultAssetsRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow assets you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the build workflow whose result assets you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assetType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssetType", + "traits": { + "smithy.api#documentation": "

The type of asset to retrieve (e.g., BUILD_LOG, QUALITY_REPORT, POLICY_DEFINITION).

", + "smithy.api#httpQuery": "assetType", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyBuildWorkflowResultAssetsResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy.

", + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the build workflow.

", + "smithy.api#required": {} + } + }, + "buildWorkflowAssets": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildResultAssets", + "traits": { + "smithy.api#documentation": "

The requested build workflow asset. This is a union type that returns only one of the available asset types (logs, reports, or generated artifacts) based on the specific asset type requested in the API call.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyNextScenario": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyNextScenarioRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyNextScenarioResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the next test scenario for validating an Automated Reasoning policy. This is used during the interactive policy refinement process to test policy behavior.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/scenarios" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyNextScenarioRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy for which you want to get the next test scenario.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the build workflow associated with the test scenarios.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyNextScenarioResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy.

", + "smithy.api#required": {} + } + }, + "scenario": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyScenario", + "traits": { + "smithy.api#documentation": "

The next test scenario to validate, including the test expression and expected results.

" + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy to retrieve. Can be either the unversioned ARN for the draft policy or an ARN for a specific policy version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the policy.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version of the policy.

", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the policy.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription", + "traits": { + "smithy.api#documentation": "

The description of the policy.

" + } + }, + "definitionHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", + "traits": { + "smithy.api#documentation": "

The hash of the policy definition used as a concurrency token.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the policy was created.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the policy was last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestCase": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestCaseRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestCaseResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details about a specific Automated Reasoning policy test.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/test-cases/{testCaseId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestCaseRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy that contains the test.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "testCaseId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the test to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestCaseResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy that contains the test.

", + "smithy.api#required": {} + } + }, + "testCase": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCase", + "traits": { + "smithy.api#documentation": "

The test details including the content, query, expected result, and metadata.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestResult": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestResultRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestResultResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the test result for a specific Automated Reasoning policy test. Returns detailed validation findings and execution status.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/test-cases/{testCaseId}/test-results" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestResultRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", + "traits": { + "smithy.api#documentation": "

The build workflow identifier. The build workflow must display a COMPLETED status to get results.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "testCaseId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the test for which to retrieve results.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetAutomatedReasoningPolicyTestResultResponse": { + "type": "structure", + "members": { + "testResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestResult", + "traits": { + "smithy.api#documentation": "

The test result containing validation findings, execution status, and detailed analysis.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetCustomModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetCustomModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetCustomModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get the properties associated with a Amazon Bedrock custom model that you have created. For more information, see Custom models in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/custom-models/{modelIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetCustomModelDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetCustomModelDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetCustomModelDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a custom model deployment, including its status, configuration, and metadata. Use this operation to monitor the deployment status and retrieve details needed for inference requests.

The following actions are related to the GetCustomModelDeployment operation:

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-customization/custom-model-deployments/{customModelDeploymentIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetCustomModelDeploymentRequest": { + "type": "structure", + "members": { + "customModelDeploymentIdentifier": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the custom model deployment to retrieve information about.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetCustomModelDeploymentResponse": { + "type": "structure", + "members": { + "customModelDeploymentArn": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model deployment.

", + "smithy.api#required": {} + } + }, + "modelDeploymentName": { + "target": "com.amazonaws.bedrock#ModelDeploymentName", + "traits": { + "smithy.api#documentation": "

The name of the custom model deployment.

", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model associated with this deployment.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the custom model deployment was created.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentStatus", + "traits": { + "smithy.api#documentation": "

The status of the custom model deployment. Possible values are:

  • CREATING - The deployment is being set up and prepared for inference.

  • ACTIVE - The deployment is ready and available for inference requests.

  • FAILED - The deployment failed to be created or became unavailable.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#CustomModelDeploymentDescription", + "traits": { + "smithy.api#documentation": "

The description of the custom model deployment.

" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "

If the deployment status is FAILED, this field contains a message describing the failure reason.

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the custom model deployment was last updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetCustomModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "

Name or Amazon Resource Name (ARN) of the custom model.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetCustomModelResponse": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) associated with this model.

", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

Model name associated with this model.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

Job name associated with this model.

" + } + }, + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "traits": { + "smithy.api#documentation": "

Job Amazon Resource Name (ARN) associated with this model. For models that you create with the CreateCustomModel API operation, this is NULL.

" + } + }, + "baseModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the base model.

" + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "

The type of model customization.

" + } + }, + "modelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" + } + }, + "hyperParameters": { + "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "traits": { + "smithy.api#documentation": "

Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.

" + } + }, + "trainingDataConfig": { + "target": "com.amazonaws.bedrock#TrainingDataConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the training dataset.

" + } + }, + "validationDataConfig": { + "target": "com.amazonaws.bedrock#ValidationDataConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the validation dataset.

" + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Output data configuration associated with this custom model.

" + } + }, + "trainingMetrics": { + "target": "com.amazonaws.bedrock#TrainingMetrics", + "traits": { + "smithy.api#documentation": "

Contains training metrics from the job creation.

" + } + }, + "validationMetrics": { + "target": "com.amazonaws.bedrock#ValidationMetrics", + "traits": { + "smithy.api#documentation": "

The validation metrics from the job creation.

" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Creation time of the model.

", + "smithy.api#required": {} + } + }, + "customizationConfig": { + "target": "com.amazonaws.bedrock#CustomizationConfig", + "traits": { + "smithy.api#documentation": "

The customization configuration for the custom model.

" + } + }, + "modelStatus": { + "target": "com.amazonaws.bedrock#ModelStatus", + "traits": { + "smithy.api#documentation": "

The current status of the custom model. Possible values include:

  • Creating - The model is being created and validated.

  • Active - The model has been successfully created and is ready for use.

  • Failed - The model creation process failed. Check the failureMessage field for details.

" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "

A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetEvaluationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetEvaluationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetEvaluationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about an evaluation job, such as the status of the job.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/evaluation-jobs/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetEvaluationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the evaluation job you want get information on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetEvaluationJobResponse": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.bedrock#EvaluationJobName", + "traits": { + "smithy.api#documentation": "

The name for the evaluation job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the evaluation job.

", + "smithy.api#required": {} + } + }, + "jobArn": { + "target": "com.amazonaws.bedrock#EvaluationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the evaluation job.

", + "smithy.api#required": {} + } + }, + "jobDescription": { + "target": "com.amazonaws.bedrock#EvaluationJobDescription", + "traits": { + "smithy.api#documentation": "

The description of the evaluation job.

" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role used in the evaluation job.

", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer managed encryption key specified when the evaluation job was created.

" + } + }, + "jobType": { + "target": "com.amazonaws.bedrock#EvaluationJobType", + "traits": { + "smithy.api#documentation": "

Specifies whether the evaluation job is automated or human-based.

", + "smithy.api#required": {} + } + }, + "applicationType": { + "target": "com.amazonaws.bedrock#ApplicationType", + "traits": { + "smithy.api#documentation": "

Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

" + } + }, + "evaluationConfig": { + "target": "com.amazonaws.bedrock#EvaluationConfig", + "traits": { + "smithy.api#documentation": "

Contains the configuration details of either an automated or human-based evaluation job.

", + "smithy.api#required": {} + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", + "traits": { + "smithy.api#documentation": "

Contains the configuration details of the inference model used for the evaluation job.

", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", + "traits": { + "smithy.api#documentation": "

Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the evaluation job was created.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the evaluation job was last modified.

" + } + }, + "failureMessages": { + "target": "com.amazonaws.bedrock#ErrorMessages", + "traits": { + "smithy.api#documentation": "

A list of strings that specify why the evaluation job failed to create.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetFoundationModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetFoundationModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get details about a Amazon Bedrock foundation model.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/foundation-models/{modelIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelAvailability": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetFoundationModelAvailabilityRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetFoundationModelAvailabilityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get information about the Foundation model availability.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/foundation-model-availability/{modelId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelAvailabilityRequest": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "

The model Id of the foundation model.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelAvailabilityResponse": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "

The model Id of the foundation model.

", + "smithy.api#required": {} + } + }, + "agreementAvailability": { + "target": "com.amazonaws.bedrock#AgreementAvailability", + "traits": { + "smithy.api#documentation": "

Agreement availability.

", + "smithy.api#required": {} + } + }, + "authorizationStatus": { + "target": "com.amazonaws.bedrock#AuthorizationStatus", + "traits": { + "smithy.api#documentation": "

Authorization status.

", + "smithy.api#required": {} + } + }, + "entitlementAvailability": { + "target": "com.amazonaws.bedrock#EntitlementAvailability", + "traits": { + "smithy.api#documentation": "

Entitlement availability.

", + "smithy.api#required": {} + } + }, + "regionAvailability": { + "target": "com.amazonaws.bedrock#RegionAvailability", + "traits": { + "smithy.api#documentation": "

Region availability.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "

The model identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelResponse": { + "type": "structure", + "members": { + "modelDetails": { + "target": "com.amazonaws.bedrock#FoundationModelDetails", + "traits": { + "smithy.api#documentation": "

Information about the foundation model.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetGuardrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/guardrails/{guardrailIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetGuardrailRequest": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrock#GuardrailVersion", + "traits": { + "smithy.api#documentation": "

The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the DRAFT version.

", + "smithy.api#httpQuery": "guardrailVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetGuardrailResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#GuardrailName", + "traits": { + "smithy.api#documentation": "

The name of the guardrail.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "

The description of the guardrail.

" + } + }, + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail.

", + "smithy.api#required": {} + } + }, + "guardrailArn": { + "target": "com.amazonaws.bedrock#GuardrailArn", + "traits": { + "smithy.api#documentation": "

The ARN of the guardrail.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailVersion", + "traits": { + "smithy.api#documentation": "

The version of the guardrail.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#GuardrailStatus", + "traits": { + "smithy.api#documentation": "

The status of the guardrail.

", + "smithy.api#required": {} + } + }, + "topicPolicy": { + "target": "com.amazonaws.bedrock#GuardrailTopicPolicy", + "traits": { + "smithy.api#documentation": "

The topic policy that was configured for the guardrail.

" + } + }, + "contentPolicy": { + "target": "com.amazonaws.bedrock#GuardrailContentPolicy", + "traits": { + "smithy.api#documentation": "

The content policy that was configured for the guardrail.

" + } + }, + "wordPolicy": { + "target": "com.amazonaws.bedrock#GuardrailWordPolicy", + "traits": { + "smithy.api#documentation": "

The word policy that was configured for the guardrail.

" + } + }, + "sensitiveInformationPolicy": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicy", + "traits": { + "smithy.api#documentation": "

The sensitive information policy that was configured for the guardrail.

" + } + }, + "contextualGroundingPolicy": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicy", + "traits": { + "smithy.api#documentation": "

The contextual grounding policy used in the guardrail.

" + } + }, + "automatedReasoningPolicy": { + "target": "com.amazonaws.bedrock#GuardrailAutomatedReasoningPolicy", + "traits": { + "smithy.api#documentation": "

The current Automated Reasoning policy configuration for the guardrail, if any is configured.

" + } + }, + "crossRegionDetails": { + "target": "com.amazonaws.bedrock#GuardrailCrossRegionDetails", + "traits": { + "smithy.api#documentation": "

Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time at which the guardrail was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time at which the guardrail was updated.

", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrock#GuardrailStatusReasons", + "traits": { + "smithy.api#documentation": "

Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

" + } + }, + "failureRecommendations": { + "target": "com.amazonaws.bedrock#GuardrailFailureRecommendations", + "traits": { + "smithy.api#documentation": "

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

" + } + }, + "blockedInputMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "

The message that the guardrail returns when it blocks a prompt.

", + "smithy.api#required": {} + } + }, + "blockedOutputsMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "

The message that the guardrail returns when it blocks a model response.

", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that encrypts the guardrail.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetImportedModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetImportedModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetImportedModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets properties associated with a customized model you imported.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/imported-models/{modelIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetImportedModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ImportedModelIdentifier", + "traits": { + "smithy.api#documentation": "

Name or Amazon Resource Name (ARN) of the imported model.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetImportedModelResponse": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#ImportedModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with this imported model.

" + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "

The name of the imported model.

" + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

Job name associated with the imported model.

" + } + }, + "jobArn": { + "target": "com.amazonaws.bedrock#ModelImportJobArn", + "traits": { + "smithy.api#documentation": "

Job Amazon Resource Name (ARN) associated with the imported model.

" + } + }, + "modelDataSource": { + "target": "com.amazonaws.bedrock#ModelDataSource", + "traits": { + "smithy.api#documentation": "

The data source for this imported model.

" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Creation time of the imported model.

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

The architecture of the imported model.

" + } + }, + "modelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "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 converse.

" + } + }, + "customModelUnits": { + "target": "com.amazonaws.bedrock#CustomModelUnits", + "traits": { + "smithy.api#documentation": "

Information about the hardware utilization for a single copy of the model.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetInferenceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetInferenceProfileRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetInferenceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about an inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/inference-profiles/{inferenceProfileIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetInferenceProfileRequest": { + "type": "structure", + "members": { + "inferenceProfileIdentifier": { + "target": "com.amazonaws.bedrock#InferenceProfileIdentifier", + "traits": { + "smithy.api#documentation": "

The ID or Amazon Resource Name (ARN) of the inference profile.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetInferenceProfileResponse": { + "type": "structure", + "members": { + "inferenceProfileName": { + "target": "com.amazonaws.bedrock#InferenceProfileName", + "traits": { + "smithy.api#documentation": "

The name of the inference profile.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#InferenceProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the inference profile.

" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the inference profile was created.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the inference profile was last updated.

" + } + }, + "inferenceProfileArn": { + "target": "com.amazonaws.bedrock#InferenceProfileArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the inference profile.

", + "smithy.api#required": {} + } + }, + "models": { + "target": "com.amazonaws.bedrock#InferenceProfileModels", + "traits": { + "smithy.api#documentation": "

A list of information about each model in the inference profile.

", + "smithy.api#required": {} + } + }, + "inferenceProfileId": { + "target": "com.amazonaws.bedrock#InferenceProfileId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the inference profile.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#InferenceProfileStatus", + "traits": { + "smithy.api#documentation": "

The status of the inference profile. ACTIVE means that the inference profile is ready to be used.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.bedrock#InferenceProfileType", + "traits": { + "smithy.api#documentation": "

The type of the inference profile. The following types are possible:

  • SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.

  • APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetMarketplaceModelEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetMarketplaceModelEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetMarketplaceModelEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/marketplace-model/endpoints/{endpointArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetMarketplaceModelEndpointRequest": { + "type": "structure", + "members": { + "endpointArn": { + "target": "com.amazonaws.bedrock#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint you want to get information about.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetMarketplaceModelEndpointResponse": { + "type": "structure", + "members": { + "marketplaceModelEndpoint": { + "target": "com.amazonaws.bedrock#MarketplaceModelEndpoint", + "traits": { + "smithy.api#documentation": "

Details about the requested endpoint.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelCopyJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelCopyJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelCopyJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-copy-jobs/{jobArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelCopyJobRequest": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model copy job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelCopyJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model copy job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelCopyJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the model copy job.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the model copy job was created.

", + "smithy.api#required": {} + } + }, + "targetModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the copied model.

", + "smithy.api#required": {} + } + }, + "targetModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

The name of the copied model.

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

The unique identifier of the account that the model being copied originated from.

", + "smithy.api#required": {} + } + }, + "sourceModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the original model being copied.

", + "smithy.api#required": {} + } + }, + "targetModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key encrypting the copied model.

" + } + }, + "targetModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

The tags associated with the copied model.

" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "

An error message for why the model copy job failed.

" + } + }, + "sourceModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

The name of the original model being copied.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelCustomizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelCustomizationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelCustomizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-customization-jobs/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelCustomizationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier for the customization job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelCustomizationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customization job.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

The name of the customization job.

", + "smithy.api#required": {} + } + }, + "outputModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

The name of the output model.

", + "smithy.api#required": {} + } + }, + "outputModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the output model.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

The token that you specified in the CreateCustomizationJob request.

" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed.

" + } + }, + "statusDetails": { + "target": "com.amazonaws.bedrock#StatusDetails", + "traits": { + "smithy.api#documentation": "

For a Distillation job, the details about the statuses of the sub-tasks of the customization job.

" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Information about why the job failed.

" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Time that the resource was created.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Time that the resource was last modified.

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

Time that the resource transitioned to terminal state.

" + } + }, + "baseModelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the base model.

", + "smithy.api#required": {} + } + }, + "hyperParameters": { + "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "traits": { + "smithy.api#documentation": "

The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.

" + } + }, + "trainingDataConfig": { + "target": "com.amazonaws.bedrock#TrainingDataConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the training dataset.

", + "smithy.api#required": {} + } + }, + "validationDataConfig": { + "target": "com.amazonaws.bedrock#ValidationDataConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the validation dataset.

", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Output data configuration

", + "smithy.api#required": {} + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "

The type of model customization.

" + } + }, + "outputModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" + } + }, + "trainingMetrics": { + "target": "com.amazonaws.bedrock#TrainingMetrics", + "traits": { + "smithy.api#documentation": "

Contains training metrics from the job creation.

" + } + }, + "validationMetrics": { + "target": "com.amazonaws.bedrock#ValidationMetrics", + "traits": { + "smithy.api#documentation": "

The loss metric for each validator that you provided in the createjob request.

" + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "

VPC configuration for the custom model job.

" + } + }, + "customizationConfig": { + "target": "com.amazonaws.bedrock#CustomizationConfig", + "traits": { + "smithy.api#documentation": "

The customization configuration for the model customization job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelImportJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the properties associated with import model job, including the status of the job. For more information, see Import a customized model in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-import-jobs/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelImportJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelImportJobIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the import job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelImportJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelImportJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the import job.

" + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

The name of the import job.

" + } + }, + "importedModelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "

The name of the imported model.

" + } + }, + "importedModelArn": { + "target": "com.amazonaws.bedrock#ImportedModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the imported model.

" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with this job.

" + } + }, + "modelDataSource": { + "target": "com.amazonaws.bedrock#ModelDataSource", + "traits": { + "smithy.api#documentation": "

The data source for the imported model.

" + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelImportJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job. A successful job transitions from in-progress to completed when the imported model is ready to use. If the job failed, the failure message contains information about why the job failed.

" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Information about why the import job failed.

" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the resource was created.

" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Time the resource was last modified.

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

Time that the resource transitioned to terminal state.

" + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "

The Virtual Private Cloud (VPC) configuration of the import model job.

" + } + }, + "importedModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The imported model is encrypted at rest using this key.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelInvocationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelInvocationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about a batch inference job. For more information, see Monitor batch inference jobs

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-invocation-job/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelInvocationJobIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelInvocationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#ModelInvocationJobName", + "traits": { + "smithy.api#documentation": "

The name of the batch inference job.

" + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#ModelId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the foundation model used for model inference.

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the batch inference job.

The following statuses are possible:

  • Submitted – This job has been submitted to a queue for validation.

  • Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:

    • Your IAM service role has access to the Amazon S3 buckets containing your files.

    • Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the modelInput value matches the request body for the model.

    • Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.

  • Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.

  • Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.

  • InProgress – This job has begun. You can start viewing the results in the output S3 location.

  • Completed – This job has successfully completed. View the output files in the output S3 location.

  • PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.

  • Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.

  • Stopped – This job was stopped by a user.

  • Stopping – This job is being stopped by a user.

" + } + }, + "message": { + "target": "com.amazonaws.bedrock#Message", + "traits": { + "smithy.api#documentation": "

If the batch inference job failed, this field contains a message describing why the job failed.

" + } + }, + "submitTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the batch inference job was submitted.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the batch inference job was last modified.

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

The time at which the batch inference job ended.

" + } + }, + "inputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", + "traits": { + "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", + "traits": { + "smithy.api#documentation": "

Details about the location of the output of the batch inference job.

", + "smithy.api#required": {} + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

" + } + }, + "timeoutDurationInHours": { + "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", + "traits": { + "smithy.api#documentation": "

The number of hours after which batch inference job was set to time out.

" + } + }, + "jobExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the batch inference job times or timed out.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Get the current configuration values for model invocation logging.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/logging/modelinvocations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse": { + "type": "structure", + "members": { + "loggingConfig": { + "target": "com.amazonaws.bedrock#LoggingConfig", + "traits": { + "smithy.api#documentation": "

The current configuration values.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetPromptRouter": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetPromptRouterRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetPromptRouterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details about a prompt router.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/prompt-routers/{promptRouterArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetPromptRouterRequest": { + "type": "structure", + "members": { + "promptRouterArn": { + "target": "com.amazonaws.bedrock#PromptRouterArn", + "traits": { + "smithy.api#documentation": "

The prompt router's ARN

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetPromptRouterResponse": { + "type": "structure", + "members": { + "promptRouterName": { + "target": "com.amazonaws.bedrock#PromptRouterName", + "traits": { + "smithy.api#documentation": "

The router's name.

", + "smithy.api#required": {} + } + }, + "routingCriteria": { + "target": "com.amazonaws.bedrock#RoutingCriteria", + "traits": { + "smithy.api#documentation": "

The router's routing criteria.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#PromptRouterDescription", + "traits": { + "smithy.api#documentation": "

The router's description.

" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

When the router was created.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

When the router was updated.

" + } + }, + "promptRouterArn": { + "target": "com.amazonaws.bedrock#PromptRouterArn", + "traits": { + "smithy.api#documentation": "

The prompt router's ARN

", + "smithy.api#required": {} + } + }, + "models": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModels", + "traits": { + "smithy.api#documentation": "

The router's models.

", + "smithy.api#required": {} + } + }, + "fallbackModel": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModel", + "traits": { "smithy.api#documentation": "

The router's fallback model.

", "smithy.api#required": {} } @@ -7462,31 +11637,81 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#input": {} + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetUseCaseForModelAccessResponse": { + "type": "structure", + "members": { + "formData": { + "target": "com.amazonaws.bedrock#AcknowledgementFormDataBody", + "traits": { + "smithy.api#documentation": "

Get customer profile Response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GuardrailArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$" + } + }, + "com.amazonaws.bedrock#GuardrailAutomatedReasoningPolicy": { + "type": "structure", + "members": { + "policies": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArnList", + "traits": { + "smithy.api#documentation": "

The list of Automated Reasoning policy ARNs that should be applied as part of this guardrail configuration.

", + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#required": {} + } + }, + "confidenceThreshold": { + "target": "com.amazonaws.bedrock#AutomatedReasoningConfidenceFilterThreshold", + "traits": { + "smithy.api#documentation": "

The minimum confidence level required for Automated Reasoning policy violations to trigger guardrail actions. Values range from 0.0 to 1.0.

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

Represents the configuration of Automated Reasoning policies within a Amazon Bedrock Guardrail, including the policies to apply and confidence thresholds.

" } }, - "com.amazonaws.bedrock#GetUseCaseForModelAccessResponse": { + "com.amazonaws.bedrock#GuardrailAutomatedReasoningPolicyConfig": { "type": "structure", "members": { - "formData": { - "target": "com.amazonaws.bedrock#AcknowledgementFormDataBody", + "policies": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArnList", "traits": { - "smithy.api#documentation": "

Get customer profile Response.

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

The list of Automated Reasoning policy ARNs to include in the guardrail configuration.

", + "smithy.api#length": { + "min": 1, + "max": 2 + }, "smithy.api#required": {} } + }, + "confidenceThreshold": { + "target": "com.amazonaws.bedrock#AutomatedReasoningConfidenceFilterThreshold", + "traits": { + "smithy.api#documentation": "

The confidence threshold for triggering guardrail actions based on Automated Reasoning policy violations.

" + } } }, "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#GuardrailArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$" + "smithy.api#documentation": "

Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.

" } }, "com.amazonaws.bedrock#GuardrailBlockedMessaging": { @@ -10059,212 +14284,601 @@ "smithy.api#enumValue": "Completed" } }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopping" - } + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStarted" + } + } + } + }, + "com.amazonaws.bedrock#KbInferenceConfig": { + "type": "structure", + "members": { + "textInferenceConfig": { + "target": "com.amazonaws.bedrock#TextInferenceConfig", + "traits": { + "smithy.api#documentation": "

Contains configuration details for text generation using a language model via the RetrieveAndGenerate function.

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

Contains configuration details of the inference for knowledge base retrieval and response generation.

" + } + }, + "com.amazonaws.bedrock#KeyPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + } + } + }, + "com.amazonaws.bedrock#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + } + }, + "com.amazonaws.bedrock#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)$" + } + }, + "com.amazonaws.bedrock#KnowledgeBaseConfig": { + "type": "union", + "members": { + "retrieveConfig": { + "target": "com.amazonaws.bedrock#RetrieveConfig", + "traits": { + "smithy.api#documentation": "

Contains configuration details for retrieving information from a knowledge base.

" + } + }, + "retrieveAndGenerateConfig": { + "target": "com.amazonaws.bedrock#RetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configuration details for retrieving information from a knowledge base and generating responses.

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

The configuration details for retrieving information from a knowledge base and generating responses.

" + } + }, + "com.amazonaws.bedrock#KnowledgeBaseId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 10 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrock#KnowledgeBaseRetrievalConfiguration": { + "type": "structure", + "members": { + "vectorSearchConfiguration": { + "target": "com.amazonaws.bedrock#KnowledgeBaseVectorSearchConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configuration details for returning the results from the vector search.

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

Contains configuration details for retrieving information from a knowledge base.

" + } + }, + "com.amazonaws.bedrock#KnowledgeBaseRetrieveAndGenerateConfiguration": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrock#KnowledgeBaseId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base.

", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#BedrockModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the foundation model or inference profile used to generate responses.

", + "smithy.api#required": {} + } + }, + "retrievalConfiguration": { + "target": "com.amazonaws.bedrock#KnowledgeBaseRetrievalConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configuration details for retrieving text chunks.

" + } + }, + "generationConfiguration": { + "target": "com.amazonaws.bedrock#GenerationConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configurations details for response generation based on retrieved text chunks.

" + } + }, + "orchestrationConfiguration": { + "target": "com.amazonaws.bedrock#OrchestrationConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configuration details for the model to process the prompt prior to retrieval and response generation.

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

Contains configuration details for retrieving information from a knowledge base and generating responses.

" + } + }, + "com.amazonaws.bedrock#KnowledgeBaseVectorSearchConfiguration": { + "type": "structure", + "members": { + "numberOfResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of text chunks to retrieve; the number of results to return.

", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "overrideSearchType": { + "target": "com.amazonaws.bedrock#SearchType", + "traits": { + "smithy.api#documentation": "

By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available.

" + } + }, + "filter": { + "target": "com.amazonaws.bedrock#RetrievalFilter", + "traits": { + "smithy.api#documentation": "

Specifies the filters to use on the metadata fields in the knowledge base data sources before returning results.

" + } + }, + "implicitFilterConfiguration": { + "target": "com.amazonaws.bedrock#ImplicitFilterConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for implicit filtering in Knowledge Base vector searches. This allows the system to automatically apply filters based on the query context without requiring explicit filter expressions.

" + } + }, + "rerankingConfiguration": { + "target": "com.amazonaws.bedrock#VectorSearchRerankingConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for reranking search results in Knowledge Base vector searches. Reranking improves search relevance by reordering initial vector search results using more sophisticated relevance models.

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

The configuration details for returning the results from the knowledge base vector search.

" + } + }, + "com.amazonaws.bedrock#LegalTerm": { + "type": "structure", + "members": { + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

URL to the legal term document.

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

The legal term of the agreement.

" + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all Automated Reasoning policies in your account, with optional filtering by policy ARN. This helps you manage and discover existing policies.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "items": "automatedReasoningPolicySummaries", + "outputToken": "nextToken", + "pageSize": "maxResults" }, - "STOPPED": { - "target": "smithy.api#Unit", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPoliciesRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#enumValue": "Stopped" + "smithy.api#documentation": "

Optional filter to list only the policy versions with the specified Amazon Resource Name (ARN). If not provided, the DRAFT versions for all policies are listed.

", + "smithy.api#httpQuery": "policyArn" } }, - "FAILED": { - "target": "smithy.api#Unit", + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", "traits": { - "smithy.api#enumValue": "Failed" + "smithy.api#documentation": "

The pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "nextToken" } }, - "NOT_STARTED": { - "target": "smithy.api#Unit", + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", "traits": { - "smithy.api#enumValue": "NotStarted" + "smithy.api#default": 25, + "smithy.api#documentation": "

The maximum number of policies to return in a single call.

", + "smithy.api#httpQuery": "maxResults" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#KbInferenceConfig": { + "com.amazonaws.bedrock#ListAutomatedReasoningPoliciesResponse": { "type": "structure", "members": { - "textInferenceConfig": { - "target": "com.amazonaws.bedrock#TextInferenceConfig", + "automatedReasoningPolicySummaries": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicySummaries", "traits": { - "smithy.api#documentation": "

Contains configuration details for text generation using a language model via the RetrieveAndGenerate function.

" + "smithy.api#documentation": "

A list of Automated Reasoning policy summaries.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

The pagination token to use in a subsequent request to retrieve the next page of results.

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

Contains configuration details of the inference for knowledge base retrieval and response generation.

" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#KeyPrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1024 + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyBuildWorkflows": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyBuildWorkflowsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyBuildWorkflowsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" } - } - }, - "com.amazonaws.bedrock#KmsKeyArn": { - "type": "string", + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 + "smithy.api#documentation": "

Lists all build workflows for an Automated Reasoning policy, showing the history of policy creation and modification attempts.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows" }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" - } - }, - "com.amazonaws.bedrock#KmsKeyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 + "smithy.api#paginated": { + "inputToken": "nextToken", + "items": "automatedReasoningPolicyBuildWorkflowSummaries", + "outputToken": "nextToken", + "pageSize": "maxResults" }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)$" + "smithy.api#readonly": {} } }, - "com.amazonaws.bedrock#KnowledgeBaseConfig": { - "type": "union", + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyBuildWorkflowsRequest": { + "type": "structure", "members": { - "retrieveConfig": { - "target": "com.amazonaws.bedrock#RetrieveConfig", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

Contains configuration details for retrieving information from a knowledge base.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflows you want to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "retrieveAndGenerateConfig": { - "target": "com.amazonaws.bedrock#RetrieveAndGenerateConfiguration", + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", "traits": { - "smithy.api#documentation": "

Contains configuration details for retrieving information from a knowledge base and generating responses.

" + "smithy.api#documentation": "

A pagination token from a previous request to continue listing build workflows from where the previous request left off.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#default": 25, + "smithy.api#documentation": "

The maximum number of build workflows to return in a single response. Valid range is 1-100.

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

The configuration details for retrieving information from a knowledge base and generating responses.

" - } - }, - "com.amazonaws.bedrock#KnowledgeBaseId": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 10 - }, - "smithy.api#pattern": "^[0-9a-zA-Z]+$" + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] } }, - "com.amazonaws.bedrock#KnowledgeBaseRetrievalConfiguration": { + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyBuildWorkflowsResponse": { "type": "structure", "members": { - "vectorSearchConfiguration": { - "target": "com.amazonaws.bedrock#KnowledgeBaseVectorSearchConfiguration", + "automatedReasoningPolicyBuildWorkflowSummaries": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowSummaries", "traits": { - "smithy.api#documentation": "

Contains configuration details for returning the results from the vector search.

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

A list of build workflow summaries, each containing key information about a build workflow including its status and timestamps.

", "smithy.api#required": {} } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

A pagination token to use in subsequent requests to retrieve additional build workflows.

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

Contains configuration details for retrieving information from a knowledge base.

" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#KnowledgeBaseRetrieveAndGenerateConfiguration": { + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestCases": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestCasesRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestCasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists tests for an Automated Reasoning policy. We recommend using pagination to ensure that the operation returns quickly and successfully.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/test-cases" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "items": "testCases", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestCasesRequest": { "type": "structure", "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrock#KnowledgeBaseId", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base.

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

The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to list tests.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "modelArn": { - "target": "com.amazonaws.bedrock#BedrockModelArn", + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the foundation model or inference profile used to generate responses.

", - "smithy.api#required": {} + "smithy.api#default": null, + "smithy.api#documentation": "

The pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "nextToken" } }, - "retrievalConfiguration": { - "target": "com.amazonaws.bedrock#KnowledgeBaseRetrievalConfiguration", + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", "traits": { - "smithy.api#documentation": "

Contains configuration details for retrieving text chunks.

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

The maximum number of tests to return in a single call.

", + "smithy.api#httpQuery": "maxResults" } - }, - "generationConfiguration": { - "target": "com.amazonaws.bedrock#GenerationConfiguration", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestCasesResponse": { + "type": "structure", + "members": { + "testCases": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseList", "traits": { - "smithy.api#documentation": "

Contains configurations details for response generation based on retrieved text chunks.

" + "smithy.api#documentation": "

A list of tests for the specified policy.

", + "smithy.api#required": {} } }, - "orchestrationConfiguration": { - "target": "com.amazonaws.bedrock#OrchestrationConfiguration", + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", "traits": { - "smithy.api#documentation": "

Contains configuration details for the model to process the prompt prior to retrieval and response generation.

" + "smithy.api#documentation": "

The pagination token to use in a subsequent request to retrieve the next page of results.

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

Contains configuration details for retrieving information from a knowledge base and generating responses.

" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#KnowledgeBaseVectorSearchConfiguration": { - "type": "structure", - "members": { - "numberOfResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The number of text chunks to retrieve; the number of results to return.

", - "smithy.api#range": { - "min": 1, - "max": 100 - } - } + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestResultsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "overrideSearchType": { - "target": "com.amazonaws.bedrock#SearchType", + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists test results for an Automated Reasoning policy, showing how the policy performed against various test scenarios and validation checks.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/test-results" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "items": "testResults", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestResultsRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy whose test results you want to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "filter": { - "target": "com.amazonaws.bedrock#RetrievalFilter", + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", "traits": { - "smithy.api#documentation": "

Specifies the filters to use on the metadata fields in the knowledge base data sources before returning results.

" + "smithy.api#documentation": "

The unique identifier of the build workflow whose test results you want to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "implicitFilterConfiguration": { - "target": "com.amazonaws.bedrock#ImplicitFilterConfiguration", + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", "traits": { - "smithy.api#documentation": "

Configuration for implicit filtering in Knowledge Base vector searches. This allows the system to automatically apply filters based on the query context without requiring explicit filter expressions.

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

A pagination token from a previous request to continue listing test results from where the previous request left off.

", + "smithy.api#httpQuery": "nextToken" } }, - "rerankingConfiguration": { - "target": "com.amazonaws.bedrock#VectorSearchRerankingConfiguration", + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", "traits": { - "smithy.api#documentation": "

Configuration for reranking search results in Knowledge Base vector searches. Reranking improves search relevance by reordering initial vector search results using more sophisticated relevance models.

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

The maximum number of test results to return in a single response. Valid range is 1-100.

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

The configuration details for returning the results from the knowledge base vector search.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#LegalTerm": { + "com.amazonaws.bedrock#ListAutomatedReasoningPolicyTestResultsResponse": { "type": "structure", "members": { - "url": { - "target": "smithy.api#String", + "testResults": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestList", "traits": { - "smithy.api#documentation": "

URL to the legal term document.

" + "smithy.api#documentation": "

A list of test results, each containing information about how the policy performed on specific test scenarios.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

A pagination token to use in subsequent requests to retrieve additional test results.

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

The legal term of the agreement.

" + "smithy.api#output": {} } }, "com.amazonaws.bedrock#ListCustomModelDeployments": { @@ -11651,45 +16265,262 @@ "smithy.api#httpQuery": "submitTimeBefore" } }, - "statusEquals": { - "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", + "statusEquals": { + "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", + "traits": { + "smithy.api#documentation": "

Specify a status to filter for batch inference jobs whose statuses match the string you specify.

The following statuses are possible:

  • Submitted – This job has been submitted to a queue for validation.

  • Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:

    • Your IAM service role has access to the Amazon S3 buckets containing your files.

    • Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the modelInput value matches the request body for the model.

    • Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.

  • Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.

  • Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.

  • InProgress – This job has begun. You can start viewing the results in the output S3 location.

  • Completed – This job has successfully completed. View the output files in the output S3 location.

  • PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.

  • Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.

  • Stopped – This job was stopped by a user.

  • Stopping – This job is being stopped by a user.

", + "smithy.api#httpQuery": "statusEquals" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#ModelInvocationJobName", + "traits": { + "smithy.api#documentation": "

Specify a string to filter for batch inference jobs whose names contain the string.

", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return. If there are more results than the number that you specify, a nextToken value is returned. Use the nextToken in a request to return the next batch of results.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If there were more results than the value you specified in the maxResults field in a previous ListModelInvocationJobs request, the response would have returned a nextToken value. To see the next batch of results, send the nextToken value in another request.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortJobsBy", + "traits": { + "smithy.api#documentation": "

An attribute by which to sort the results.

", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "

Specifies whether to sort the results by ascending or descending order.

", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListModelInvocationJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If there are more results than can fit in the response, a nextToken is returned. Use the nextToken in a request to return the next batch of results.

" + } + }, + "invocationJobSummaries": { + "target": "com.amazonaws.bedrock#ModelInvocationJobSummaries", + "traits": { + "smithy.api#documentation": "

A list of items, each of which contains a summary about a batch inference job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListPromptRouters": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListPromptRoutersRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListPromptRoutersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of prompt routers.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/prompt-routers" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "promptRouterSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListPromptRoutersRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of prompt routers to return in one page of results.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "type": { + "target": "com.amazonaws.bedrock#PromptRouterType", + "traits": { + "smithy.api#default": "default", + "smithy.api#documentation": "

The type of the prompt routers, such as whether it's default or custom.

", + "smithy.api#httpQuery": "type" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListPromptRoutersResponse": { + "type": "structure", + "members": { + "promptRouterSummaries": { + "target": "com.amazonaws.bedrock#PromptRouterSummaries", + "traits": { + "smithy.api#documentation": "

A list of prompt router summaries.

" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListProvisionedModelThroughputs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/provisioned-model-throughputs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "provisionedModelSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns Provisioned Throughputs created after the specified time.

", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns Provisioned Throughputs created before the specified time.

", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "

A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.

", + "smithy.api#httpQuery": "statusEquals" + } + }, + "modelArnEquals": { + "target": "com.amazonaws.bedrock#ModelArn", "traits": { - "smithy.api#documentation": "

Specify a status to filter for batch inference jobs whose statuses match the string you specify.

The following statuses are possible:

  • Submitted – This job has been submitted to a queue for validation.

  • Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:

    • Your IAM service role has access to the Amazon S3 buckets containing your files.

    • Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the modelInput value matches the request body for the model.

    • Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.

  • Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.

  • Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.

  • InProgress – This job has begun. You can start viewing the results in the output S3 location.

  • Completed – This job has successfully completed. View the output files in the output S3 location.

  • PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.

  • Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.

  • Stopped – This job was stopped by a user.

  • Stopping – This job is being stopped by a user.

", - "smithy.api#httpQuery": "statusEquals" + "smithy.api#documentation": "

A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.

", + "smithy.api#httpQuery": "modelArnEquals" } }, "nameContains": { - "target": "com.amazonaws.bedrock#ModelInvocationJobName", + "target": "com.amazonaws.bedrock#ProvisionedModelName", "traits": { - "smithy.api#documentation": "

Specify a string to filter for batch inference jobs whose names contain the string.

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

A filter that returns Provisioned Throughputs if their name contains the expression that you specify.

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

The maximum number of results to return. If there are more results than the number that you specify, a nextToken value is returned. Use the nextToken in a request to return the next batch of results.

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

THe maximum number of results to return in the response. If there are more results than the number you specified, the response returns a nextToken value. To see the next batch of results, send the nextToken value in another list request.

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

If there were more results than the value you specified in the maxResults field in a previous ListModelInvocationJobs request, the response would have returned a nextToken value. To see the next batch of results, send the nextToken value in another request.

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

If there are more results than the number you specified in the maxResults field, the response returns a nextToken value. To see the next batch of results, specify the nextToken value in this field.

", "smithy.api#httpQuery": "nextToken" } }, "sortBy": { - "target": "com.amazonaws.bedrock#SortJobsBy", + "target": "com.amazonaws.bedrock#SortByProvisionedModels", "traits": { - "smithy.api#documentation": "

An attribute by which to sort the results.

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

The field by which to sort the returned list of Provisioned Throughputs.

", "smithy.api#httpQuery": "sortBy" } }, "sortOrder": { "target": "com.amazonaws.bedrock#SortOrder", "traits": { - "smithy.api#documentation": "

Specifies whether to sort the results by ascending or descending order.

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

The sort order of the results.

", "smithy.api#httpQuery": "sortOrder" } } @@ -11698,19 +16529,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#ListModelInvocationJobsResponse": { + "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.bedrock#PaginationToken", "traits": { - "smithy.api#documentation": "

If there are more results than can fit in the response, a nextToken is returned. Use the nextToken in a request to return the next batch of results.

" + "smithy.api#documentation": "

If there are more results than the number you specified in the maxResults field, this value is returned. To see the next batch of results, include this value in the nextToken field in another list request.

" } }, - "invocationJobSummaries": { - "target": "com.amazonaws.bedrock#ModelInvocationJobSummaries", + "provisionedModelSummaries": { + "target": "com.amazonaws.bedrock#ProvisionedModelSummaries", "traits": { - "smithy.api#documentation": "

A list of items, each of which contains a summary about a batch inference job.

" + "smithy.api#documentation": "

A list of summaries, one for each Provisioned Throughput in the response.

" } } }, @@ -11718,13 +16549,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrock#ListPromptRouters": { + "com.amazonaws.bedrock#ListTagsForResource": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#ListPromptRoutersRequest" + "target": "com.amazonaws.bedrock#ListTagsForResourceRequest" }, "output": { - "target": "com.amazonaws.bedrock#ListPromptRoutersResponse" + "target": "com.amazonaws.bedrock#ListTagsForResourceResponse" }, "errors": [ { @@ -11733,6 +16564,9 @@ { "target": "com.amazonaws.bedrock#InternalServerException" }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, { "target": "com.amazonaws.bedrock#ThrottlingException" }, @@ -11741,594 +16575,735 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of prompt routers.

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

List the tags associated with the specified resource.

For more information, see Tagging resources in the Amazon Bedrock User Guide.

", "smithy.api#http": { "code": 200, - "method": "GET", - "uri": "/prompt-routers" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "promptRouterSummaries" - }, - "smithy.api#readonly": {} + "method": "POST", + "uri": "/listTagsForResource" + } } }, - "com.amazonaws.bedrock#ListPromptRoutersRequest": { + "com.amazonaws.bedrock#ListTagsForResourceRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.bedrock#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of prompt routers to return in one page of results.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", + "resourceARN": { + "target": "com.amazonaws.bedrock#TaggableResourcesArn", "traits": { - "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} } - }, - "type": { - "target": "com.amazonaws.bedrock#PromptRouterType", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.bedrock#TagList", "traits": { - "smithy.api#default": "default", - "smithy.api#documentation": "

The type of the prompt routers, such as whether it's default or custom.

", - "smithy.api#httpQuery": "type" + "smithy.api#documentation": "

An array of the tags associated with this resource.

" } } }, "traits": { - "smithy.api#input": {} + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#ListPromptRoutersResponse": { + "com.amazonaws.bedrock#LogGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.bedrock#LoggingConfig": { "type": "structure", "members": { - "promptRouterSummaries": { - "target": "com.amazonaws.bedrock#PromptRouterSummaries", + "cloudWatchConfig": { + "target": "com.amazonaws.bedrock#CloudWatchConfig", "traits": { - "smithy.api#documentation": "

A list of prompt router summaries.

" + "smithy.api#documentation": "

CloudWatch logging configuration.

" } }, - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", + "s3Config": { + "target": "com.amazonaws.bedrock#S3Config", "traits": { - "smithy.api#documentation": "

Specify the pagination token from a previous request to retrieve the next page of results.

" + "smithy.api#documentation": "

S3 configuration for storing log data.

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

Set to include text data in the log delivery.

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

Set to include image data in the log delivery.

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

Set to include embeddings data in the log delivery.

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

Set to include video data in the log delivery.

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

Configuration fields for invocation logging.

" } }, - "com.amazonaws.bedrock#ListProvisionedModelThroughputs": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, + "com.amazonaws.bedrock#LoggingResource": { + "type": "resource", + "operations": [ { - "target": "com.amazonaws.bedrock#InternalServerException" + "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfiguration" }, { - "target": "com.amazonaws.bedrock#ThrottlingException" + "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfiguration" }, { - "target": "com.amazonaws.bedrock#ValidationException" + "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfiguration" } - ], - "traits": { - "smithy.api#documentation": "

Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/provisioned-model-throughputs" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "provisionedModelSummaries" - }, - "smithy.api#readonly": {} - } + ] }, - "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest": { + "com.amazonaws.bedrock#MarketplaceModelEndpoint": { "type": "structure", "members": { - "creationTimeAfter": { + "endpointArn": { + "target": "com.amazonaws.bedrock#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint.

", + "smithy.api#required": {} + } + }, + "modelSourceIdentifier": { + "target": "com.amazonaws.bedrock#ModelSourceIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the model from Amazon Bedrock Marketplace that is deployed on this endpoint.

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

The overall status of the endpoint in Amazon Bedrock Marketplace (e.g., ACTIVE, INACTIVE).

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

Additional information about the overall status, if available.

" + } + }, + "createdAt": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

A filter that returns Provisioned Throughputs created after the specified time.

", - "smithy.api#httpQuery": "creationTimeAfter" + "smithy.api#documentation": "

The timestamp when the endpoint was registered.

", + "smithy.api#required": {} } }, - "creationTimeBefore": { + "updatedAt": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

A filter that returns Provisioned Throughputs created before the specified time.

", - "smithy.api#httpQuery": "creationTimeBefore" + "smithy.api#documentation": "

The timestamp when the endpoint was last updated.

", + "smithy.api#required": {} } }, - "statusEquals": { - "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "endpointConfig": { + "target": "com.amazonaws.bedrock#EndpointConfig", "traits": { - "smithy.api#documentation": "

A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.

", - "smithy.api#httpQuery": "statusEquals" + "smithy.api#documentation": "

The configuration of the endpoint, including the number and type of instances used.

", + "smithy.api#required": {} } }, - "modelArnEquals": { - "target": "com.amazonaws.bedrock#ModelArn", + "endpointStatus": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The current status of the endpoint (e.g., Creating, InService, Updating, Failed).

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

Additional information about the endpoint status, if available.

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

Contains details about an endpoint for a model from Amazon Bedrock Marketplace.

" + } + }, + "com.amazonaws.bedrock#MarketplaceModelEndpointSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#MarketplaceModelEndpointSummary" + }, + "traits": { + "smithy.api#length": { + "max": 1000 + } + } + }, + "com.amazonaws.bedrock#MarketplaceModelEndpointSummary": { + "type": "structure", + "members": { + "endpointArn": { + "target": "com.amazonaws.bedrock#Arn", "traits": { - "smithy.api#documentation": "

A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.

", - "smithy.api#httpQuery": "modelArnEquals" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint.

", + "smithy.api#required": {} } }, - "nameContains": { - "target": "com.amazonaws.bedrock#ProvisionedModelName", + "modelSourceIdentifier": { + "target": "com.amazonaws.bedrock#ModelSourceIdentifier", "traits": { - "smithy.api#documentation": "

A filter that returns Provisioned Throughputs if their name contains the expression that you specify.

", - "smithy.api#httpQuery": "nameContains" + "smithy.api#documentation": "

The ARN of the model from Amazon Bedrock Marketplace that is deployed on this endpoint.

", + "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.bedrock#MaxResults", + "status": { + "target": "com.amazonaws.bedrock#Status", "traits": { - "smithy.api#documentation": "

THe maximum number of results to return in the response. If there are more results than the number you specified, the response returns a nextToken value. To see the next batch of results, send the nextToken value in another list request.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The overall status of the endpoint in Amazon Bedrock Marketplace.

" } }, - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", + "statusMessage": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If there are more results than the number you specified in the maxResults field, the response returns a nextToken value. To see the next batch of results, specify the nextToken value in this field.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

Additional information about the overall status, if available.

" } }, - "sortBy": { - "target": "com.amazonaws.bedrock#SortByProvisionedModels", + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The field by which to sort the returned list of Provisioned Throughputs.

", - "smithy.api#httpQuery": "sortBy" + "smithy.api#documentation": "

The timestamp when the endpoint was created.

", + "smithy.api#required": {} } }, - "sortOrder": { - "target": "com.amazonaws.bedrock#SortOrder", + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The sort order of the results.

", - "smithy.api#httpQuery": "sortOrder" + "smithy.api#documentation": "

The timestamp when the endpoint was last updated.

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

Provides a summary of an endpoint for a model from Amazon Bedrock Marketplace.

" } }, - "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse": { + "com.amazonaws.bedrock#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrock#MaxTokens": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65536 + } + } + }, + "com.amazonaws.bedrock#Message": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#MetadataAttributeSchema": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", + "key": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If there are more results than the number you specified in the maxResults field, this value is returned. To see the next batch of results, include this value in the nextToken field in another list request.

" + "smithy.api#documentation": "

The unique identifier for the metadata attribute. This key is used to reference the attribute in filter expressions and reranking configurations.

", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#required": {} } }, - "provisionedModelSummaries": { - "target": "com.amazonaws.bedrock#ProvisionedModelSummaries", + "type": { + "target": "com.amazonaws.bedrock#AttributeType", "traits": { - "smithy.api#documentation": "

A list of summaries, one for each Provisioned Throughput in the response.

" + "smithy.api#documentation": "

The data type of the metadata attribute. The type determines how the attribute can be used in filter expressions and reranking.

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

An optional description of the metadata attribute that provides additional context about its purpose and usage.

", + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

Defines the schema for a metadata attribute used in Knowledge Base vector searches. Metadata attributes provide additional context for documents and can be used for filtering and reranking search results.

", + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrock#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#ListTagsForResourceResponse" + "com.amazonaws.bedrock#MetadataAttributeSchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#MetadataAttributeSchema" }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "

List the tags associated with the specified resource.

For more information, see Tagging resources in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/listTagsForResource" + "smithy.api#length": { + "min": 1, + "max": 25 } } }, - "com.amazonaws.bedrock#ListTagsForResourceRequest": { + "com.amazonaws.bedrock#MetadataConfigurationForReranking": { "type": "structure", "members": { - "resourceARN": { - "target": "com.amazonaws.bedrock#TaggableResourcesArn", + "selectionMode": { + "target": "com.amazonaws.bedrock#RerankingMetadataSelectionMode", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

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

The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.bedrock#TagList", + }, + "selectiveModeConfiguration": { + "target": "com.amazonaws.bedrock#RerankingMetadataSelectiveModeConfiguration", "traits": { - "smithy.api#documentation": "

An array of the tags associated with this resource.

" + "smithy.api#documentation": "

Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.

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

Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches. This determines which metadata fields are included or excluded when reordering search results.

" } }, - "com.amazonaws.bedrock#LogGroupName": { + "com.amazonaws.bedrock#MetricFloat": { + "type": "float" + }, + "com.amazonaws.bedrock#MetricName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 512 + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#ModelArchitecture": { + "type": "string" + }, + "com.amazonaws.bedrock#ModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([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}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))$" + } + }, + "com.amazonaws.bedrock#ModelCopyJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ModelCopyJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } } } }, - "com.amazonaws.bedrock#LoggingConfig": { + "com.amazonaws.bedrock#ModelCopyJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelCopyJobSummary" + } + }, + "com.amazonaws.bedrock#ModelCopyJobSummary": { "type": "structure", "members": { - "cloudWatchConfig": { - "target": "com.amazonaws.bedrock#CloudWatchConfig", + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resoource Name (ARN) of the model copy job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelCopyJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the model copy job.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

CloudWatch logging configuration.

" + "smithy.api#documentation": "

The time that the model copy job was created.

", + "smithy.api#required": {} } }, - "s3Config": { - "target": "com.amazonaws.bedrock#S3Config", + "targetModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", "traits": { - "smithy.api#documentation": "

S3 configuration for storing log data.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the copied model.

", + "smithy.api#required": {} } }, - "textDataDeliveryEnabled": { - "target": "smithy.api#Boolean", + "targetModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", "traits": { - "smithy.api#documentation": "

Set to include text data in the log delivery.

" + "smithy.api#documentation": "

The name of the copied model.

" } }, - "imageDataDeliveryEnabled": { - "target": "smithy.api#Boolean", + "sourceAccountId": { + "target": "com.amazonaws.bedrock#AccountId", "traits": { - "smithy.api#documentation": "

Set to include image data in the log delivery.

" + "smithy.api#documentation": "

The unique identifier of the account that the model being copied originated from.

", + "smithy.api#required": {} } }, - "embeddingDataDeliveryEnabled": { - "target": "smithy.api#Boolean", + "sourceModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", "traits": { - "smithy.api#documentation": "

Set to include embeddings data in the log delivery.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the original model being copied.

", + "smithy.api#required": {} } }, - "videoDataDeliveryEnabled": { - "target": "smithy.api#Boolean", + "targetModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", "traits": { - "smithy.api#documentation": "

Set to include video data in the log delivery.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied model.

" + } + }, + "targetModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

Tags associated with the copied model.

" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "

If a model fails to be copied, a message describing why the job failed is included here.

" + } + }, + "sourceModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

The name of the original model being copied.

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

Configuration fields for invocation logging.

" + "smithy.api#documentation": "

Contains details about each model copy job.

This data type is used in the following API operations:

" } }, - "com.amazonaws.bedrock#LoggingResource": { + "com.amazonaws.bedrock#ModelCopyResource": { "type": "resource", "operations": [ { - "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfiguration" + "target": "com.amazonaws.bedrock#CreateModelCopyJob" }, { - "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfiguration" + "target": "com.amazonaws.bedrock#GetModelCopyJob" }, { - "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfiguration" + "target": "com.amazonaws.bedrock#ListModelCopyJobs" } ] }, - "com.amazonaws.bedrock#MarketplaceModelEndpoint": { - "type": "structure", + "com.amazonaws.bedrock#ModelCustomization": { + "type": "enum", "members": { - "endpointArn": { - "target": "com.amazonaws.bedrock#Arn", + "FINE_TUNING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint.

", - "smithy.api#required": {} + "smithy.api#enumValue": "FINE_TUNING" } }, - "modelSourceIdentifier": { - "target": "com.amazonaws.bedrock#ModelSourceIdentifier", + "CONTINUED_PRE_TRAINING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The ARN of the model from Amazon Bedrock Marketplace that is deployed on this endpoint.

", - "smithy.api#required": {} + "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" } }, - "status": { - "target": "com.amazonaws.bedrock#Status", + "DISTILLATION": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The overall status of the endpoint in Amazon Bedrock Marketplace (e.g., ACTIVE, INACTIVE).

" + "smithy.api#enumValue": "DISTILLATION" } + } + } + }, + "com.amazonaws.bedrock#ModelCustomizationHyperParameters": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bedrock#ModelCustomizationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 }, - "statusMessage": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Additional information about the overall status, if available.

" - } + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ModelCustomizationJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 }, - "createdAt": { - "target": "com.amazonaws.bedrock#Timestamp", + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*)$" + } + }, + "com.amazonaws.bedrock#ModelCustomizationJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The timestamp when the endpoint was registered.

", - "smithy.api#required": {} + "smithy.api#enumValue": "InProgress" } }, - "updatedAt": { - "target": "com.amazonaws.bedrock#Timestamp", + "COMPLETED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The timestamp when the endpoint was last updated.

", - "smithy.api#required": {} + "smithy.api#enumValue": "Completed" } }, - "endpointConfig": { - "target": "com.amazonaws.bedrock#EndpointConfig", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The configuration of the endpoint, including the number and type of instances used.

", - "smithy.api#required": {} + "smithy.api#enumValue": "Failed" } }, - "endpointStatus": { - "target": "smithy.api#String", + "STOPPING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The current status of the endpoint (e.g., Creating, InService, Updating, Failed).

", - "smithy.api#required": {} + "smithy.api#enumValue": "Stopping" } }, - "endpointStatusMessage": { - "target": "smithy.api#String", + "STOPPED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Additional information about the endpoint status, if available.

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

Contains details about an endpoint for a model from Amazon Bedrock Marketplace.

" } }, - "com.amazonaws.bedrock#MarketplaceModelEndpointSummaries": { + "com.amazonaws.bedrock#ModelCustomizationJobSummaries": { "type": "list", "member": { - "target": "com.amazonaws.bedrock#MarketplaceModelEndpointSummary" - }, - "traits": { - "smithy.api#length": { - "max": 1000 - } + "target": "com.amazonaws.bedrock#ModelCustomizationJobSummary" } }, - "com.amazonaws.bedrock#MarketplaceModelEndpointSummary": { + "com.amazonaws.bedrock#ModelCustomizationJobSummary": { "type": "structure", "members": { - "endpointArn": { - "target": "com.amazonaws.bedrock#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the endpoint.

", - "smithy.api#required": {} - } - }, - "modelSourceIdentifier": { - "target": "com.amazonaws.bedrock#ModelSourceIdentifier", - "traits": { - "smithy.api#documentation": "

The ARN of the model from Amazon Bedrock Marketplace that is deployed on this endpoint.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#Status", - "traits": { - "smithy.api#documentation": "

The overall status of the endpoint in Amazon Bedrock Marketplace.

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

Additional information about the overall status, if available.

" - } - }, - "createdAt": { - "target": "com.amazonaws.bedrock#Timestamp", + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", "traits": { - "smithy.api#documentation": "

The timestamp when the endpoint was created.

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

Amazon Resource Name (ARN) of the customization job.

", "smithy.api#required": {} } }, - "updatedAt": { - "target": "com.amazonaws.bedrock#Timestamp", + "baseModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", "traits": { - "smithy.api#documentation": "

The timestamp when the endpoint was last updated.

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

Amazon Resource Name (ARN) of the base model.

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

Provides a summary of an endpoint for a model from Amazon Bedrock Marketplace.

" - } - }, - "com.amazonaws.bedrock#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.bedrock#MaxTokens": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 65536 - } - } - }, - "com.amazonaws.bedrock#Message": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#MetadataAttributeSchema": { - "type": "structure", - "members": { - "key": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The unique identifier for the metadata attribute. This key is used to reference the attribute in filter expressions and reranking configurations.

", - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[\\s\\S]+$", + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

Name of the customization job.

", "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.bedrock#AttributeType", + "status": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", "traits": { - "smithy.api#documentation": "

The data type of the metadata attribute. The type determines how the attribute can be used in filter expressions and reranking.

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

Status of the customization job.

", "smithy.api#required": {} } }, - "description": { - "target": "smithy.api#String", + "statusDetails": { + "target": "com.amazonaws.bedrock#StatusDetails", "traits": { - "smithy.api#documentation": "

An optional description of the metadata attribute that provides additional context about its purpose and usage.

", - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[\\s\\S]+$", + "smithy.api#documentation": "

Details about the status of the data processing sub-task of the job.

" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Time that the customization job was last modified.

" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Creation time of the custom model.

", "smithy.api#required": {} } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Time that the customization job ended.

" + } + }, + "customModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the custom model.

" + } + }, + "customModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

Name of the custom model.

" + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "

Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

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

Defines the schema for a metadata attribute used in Knowledge Base vector searches. Metadata attributes provide additional context for documents and can be used for filtering and reranking search results.

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

Information about one customization job

" } }, - "com.amazonaws.bedrock#MetadataAttributeSchemaList": { + "com.amazonaws.bedrock#ModelCustomizationList": { "type": "list", "member": { - "target": "com.amazonaws.bedrock#MetadataAttributeSchema" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } + "target": "com.amazonaws.bedrock#ModelCustomization" } }, - "com.amazonaws.bedrock#MetadataConfigurationForReranking": { - "type": "structure", + "com.amazonaws.bedrock#ModelDataSource": { + "type": "union", "members": { - "selectionMode": { - "target": "com.amazonaws.bedrock#RerankingMetadataSelectionMode", - "traits": { - "smithy.api#documentation": "

The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).

", - "smithy.api#required": {} - } - }, - "selectiveModeConfiguration": { - "target": "com.amazonaws.bedrock#RerankingMetadataSelectiveModeConfiguration", + "s3DataSource": { + "target": "com.amazonaws.bedrock#S3DataSource", "traits": { - "smithy.api#documentation": "

Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.

" + "smithy.api#documentation": "

The Amazon S3 data source of the model to import.

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

Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches. This determines which metadata fields are included or excluded when reordering search results.

" + "smithy.api#documentation": "

The data source of the model to import.

" } }, - "com.amazonaws.bedrock#MetricFloat": { - "type": "float" - }, - "com.amazonaws.bedrock#MetricName": { + "com.amazonaws.bedrock#ModelDeploymentName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, - "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", - "smithy.api#sensitive": {} + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,63}$" } }, - "com.amazonaws.bedrock#ModelArchitecture": { - "type": "string" + "com.amazonaws.bedrock#ModelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "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})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$)|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)))|([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][_-]?)+)$" + } }, - "com.amazonaws.bedrock#ModelArn": { + "com.amazonaws.bedrock#ModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([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][_-]?)+)$" + } + }, + "com.amazonaws.bedrock#ModelImportJobArn": { "type": "string", "traits": { "smithy.api#length": { - "min": 20, "max": 1011 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([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}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))$" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12}$" } }, - "com.amazonaws.bedrock#ModelCopyJobArn": { + "com.amazonaws.bedrock#ModelImportJobIdentifier": { "type": "string", "traits": { "smithy.api#length": { "max": 1011 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*)$" } }, - "com.amazonaws.bedrock#ModelCopyJobStatus": { + "com.amazonaws.bedrock#ModelImportJobStatus": { "type": "enum", "members": { "IN_PROGRESS": { @@ -12351,159 +17326,241 @@ } } }, - "com.amazonaws.bedrock#ModelCopyJobSummaries": { + "com.amazonaws.bedrock#ModelImportJobSummaries": { "type": "list", "member": { - "target": "com.amazonaws.bedrock#ModelCopyJobSummary" + "target": "com.amazonaws.bedrock#ModelImportJobSummary" } }, - "com.amazonaws.bedrock#ModelCopyJobSummary": { + "com.amazonaws.bedrock#ModelImportJobSummary": { "type": "structure", "members": { "jobArn": { - "target": "com.amazonaws.bedrock#ModelCopyJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resoource Name (ARN) of the model copy job.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#ModelCopyJobStatus", + "target": "com.amazonaws.bedrock#ModelImportJobArn", "traits": { - "smithy.api#documentation": "

The status of the model copy job.

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

The Amazon Resource Name (ARN) of the import job.

", "smithy.api#required": {} } }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "jobName": { + "target": "com.amazonaws.bedrock#JobName", "traits": { - "smithy.api#documentation": "

The time that the model copy job was created.

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

The name of the import job.

", "smithy.api#required": {} } }, - "targetModelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", + "status": { + "target": "com.amazonaws.bedrock#ModelImportJobStatus", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the copied model.

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

The status of the imported job.

", "smithy.api#required": {} } }, - "targetModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The name of the copied model.

" + "smithy.api#documentation": "

The time when the import job was last modified.

" } }, - "sourceAccountId": { - "target": "com.amazonaws.bedrock#AccountId", + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The unique identifier of the account that the model being copied originated from.

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

The time import job was created.

", "smithy.api#required": {} } }, - "sourceModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the original model being copied.

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

The time when import job ended.

" } }, - "targetModelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", + "importedModelArn": { + "target": "com.amazonaws.bedrock#ImportedModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied model.

" + "smithy.api#documentation": "

The Amazon resource Name (ARN) of the imported model.

" } }, - "targetModelTags": { - "target": "com.amazonaws.bedrock#TagList", + "importedModelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", "traits": { - "smithy.api#documentation": "

Tags associated with the copied model.

" + "smithy.api#documentation": "

The name of the imported model.

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

Information about the import job.

" + } + }, + "com.amazonaws.bedrock#ModelImportResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateModelImportJob" }, - "failureMessage": { - "target": "com.amazonaws.bedrock#ErrorMessage", + { + "target": "com.amazonaws.bedrock#DeleteImportedModel" + }, + { + "target": "com.amazonaws.bedrock#GetImportedModel" + }, + { + "target": "com.amazonaws.bedrock#GetModelImportJob" + }, + { + "target": "com.amazonaws.bedrock#ListImportedModels" + }, + { + "target": "com.amazonaws.bedrock#ListModelImportJobs" + } + ] + }, + "com.amazonaws.bedrock#ModelInvocationIdempotencyToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{1,256}(-*[a-zA-Z0-9]){0,256}$" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/[a-z0-9]{12})$" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^((arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/)?[a-z0-9]{12})$" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig": { + "type": "union", + "members": { + "s3InputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobS3InputDataConfig", "traits": { - "smithy.api#documentation": "

If a model fails to be copied, a message describing why the job failed is included here.

" + "smithy.api#documentation": "

Contains the configuration of the S3 location of the input data.

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

Details about the location of the input to the batch inference job.

" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 }, - "sourceModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", + "smithy.api#pattern": "^[a-zA-Z0-9]{1,63}(-*[a-zA-Z0-9\\+\\-\\.]){0,63}$" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig": { + "type": "union", + "members": { + "s3OutputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobS3OutputDataConfig", "traits": { - "smithy.api#documentation": "

The name of the original model being copied.

" + "smithy.api#documentation": "

Contains the configuration of the S3 location of the output data.

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

Contains details about each model copy job.

This data type is used in the following API operations:

" + "smithy.api#documentation": "

Contains the configuration of the S3 location of the output data.

" } }, - "com.amazonaws.bedrock#ModelCopyResource": { + "com.amazonaws.bedrock#ModelInvocationJobResource": { "type": "resource", "operations": [ { - "target": "com.amazonaws.bedrock#CreateModelCopyJob" + "target": "com.amazonaws.bedrock#CreateModelInvocationJob" }, { - "target": "com.amazonaws.bedrock#GetModelCopyJob" + "target": "com.amazonaws.bedrock#GetModelInvocationJob" }, { - "target": "com.amazonaws.bedrock#ListModelCopyJobs" + "target": "com.amazonaws.bedrock#ListModelInvocationJobs" + }, + { + "target": "com.amazonaws.bedrock#StopModelInvocationJob" } ] }, - "com.amazonaws.bedrock#ModelCustomization": { - "type": "enum", + "com.amazonaws.bedrock#ModelInvocationJobS3InputDataConfig": { + "type": "structure", "members": { - "FINE_TUNING": { - "target": "smithy.api#Unit", + "s3InputFormat": { + "target": "com.amazonaws.bedrock#S3InputFormat", "traits": { - "smithy.api#enumValue": "FINE_TUNING" + "smithy.api#documentation": "

The format of the input data.

" } }, - "CONTINUED_PRE_TRAINING": { - "target": "smithy.api#Unit", + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", "traits": { - "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" + "smithy.api#documentation": "

The S3 location of the input data.

", + "smithy.api#required": {} } }, - "DISTILLATION": { - "target": "smithy.api#Unit", + "s3BucketOwner": { + "target": "com.amazonaws.bedrock#AccountId", "traits": { - "smithy.api#enumValue": "DISTILLATION" + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the S3 bucket containing the input data.

" } } - } - }, - "com.amazonaws.bedrock#ModelCustomizationHyperParameters": { - "type": "map", - "key": { - "target": "smithy.api#String" }, - "value": { - "target": "smithy.api#String" - } - }, - "com.amazonaws.bedrock#ModelCustomizationJobArn": { - "type": "string", "traits": { - "smithy.api#length": { - "max": 1011 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}$" + "smithy.api#documentation": "

Contains the configuration of the S3 location of the input data.

" } }, - "com.amazonaws.bedrock#ModelCustomizationJobIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1011 + "com.amazonaws.bedrock#ModelInvocationJobS3OutputDataConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 location of the output data.

", + "smithy.api#required": {} + } }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*)$" + "s3EncryptionKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the key that encrypts the S3 location of the output data.

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

The ID of the Amazon Web Services account that owns the S3 bucket containing the output data.

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

Contains the configuration of the S3 location of the output data.

" } }, - "com.amazonaws.bedrock#ModelCustomizationJobStatus": { + "com.amazonaws.bedrock#ModelInvocationJobStatus": { "type": "enum", "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Submitted" + } + }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { @@ -12533,175 +17590,225 @@ "traits": { "smithy.api#enumValue": "Stopped" } + }, + "PARTIALLY_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PartiallyCompleted" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Expired" + } + }, + "VALIDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Validating" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scheduled" + } } } }, - "com.amazonaws.bedrock#ModelCustomizationJobSummaries": { + "com.amazonaws.bedrock#ModelInvocationJobSummaries": { "type": "list", "member": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobSummary" + "target": "com.amazonaws.bedrock#ModelInvocationJobSummary" } }, - "com.amazonaws.bedrock#ModelCustomizationJobSummary": { + "com.amazonaws.bedrock#ModelInvocationJobSummary": { "type": "structure", "members": { "jobArn": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "target": "com.amazonaws.bedrock#ModelInvocationJobArn", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the customization job.

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

The Amazon Resource Name (ARN) of the batch inference job.

", "smithy.api#required": {} } }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + "jobName": { + "target": "com.amazonaws.bedrock#ModelInvocationJobName", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the base model.

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

The name of the batch inference job.

", "smithy.api#required": {} } }, - "jobName": { - "target": "com.amazonaws.bedrock#JobName", + "modelId": { + "target": "com.amazonaws.bedrock#ModelId", "traits": { - "smithy.api#documentation": "

Name of the customization job.

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

The unique identifier of the foundation model used for model inference.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", + "clientRequestToken": { + "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", "traits": { - "smithy.api#documentation": "

Status of the customization job.

", + "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

", "smithy.api#required": {} } }, - "statusDetails": { - "target": "com.amazonaws.bedrock#StatusDetails", + "status": { + "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", "traits": { - "smithy.api#documentation": "

Details about the status of the data processing sub-task of the job.

" + "smithy.api#documentation": "

The status of the batch inference job.

The following statuses are possible:

  • Submitted – This job has been submitted to a queue for validation.

  • Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:

    • Your IAM service role has access to the Amazon S3 buckets containing your files.

    • Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the modelInput value matches the request body for the model.

    • Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.

  • Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.

  • Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.

  • InProgress – This job has begun. You can start viewing the results in the output S3 location.

  • Completed – This job has successfully completed. View the output files in the output S3 location.

  • PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.

  • Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.

  • Stopped – This job was stopped by a user.

  • Stopping – This job is being stopped by a user.

" } }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "message": { + "target": "com.amazonaws.bedrock#Message", "traits": { - "smithy.api#documentation": "

Time that the customization job was last modified.

" + "smithy.api#documentation": "

If the batch inference job failed, this field contains a message describing why the job failed.

" } }, - "creationTime": { + "submitTime": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

Creation time of the custom model.

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

The time at which the batch inference job was submitted.

", "smithy.api#required": {} } }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the batch inference job was last modified.

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

Time that the customization job ended.

" + "smithy.api#documentation": "

The time at which the batch inference job ended.

" } }, - "customModelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", + "inputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the custom model.

" + "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

", + "smithy.api#required": {} } }, - "customModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", + "outputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", "traits": { - "smithy.api#documentation": "

Name of the custom model.

" + "smithy.api#documentation": "

Details about the location of the output of the batch inference job.

", + "smithy.api#required": {} } }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", "traits": { - "smithy.api#documentation": "

Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

" + "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

" + } + }, + "timeoutDurationInHours": { + "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", + "traits": { + "smithy.api#documentation": "

The number of hours after which the batch inference job was set to time out.

" + } + }, + "jobExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the batch inference job times or timed out.

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

Information about one customization job

" + "smithy.api#documentation": "

A summary of a batch inference job.

" } }, - "com.amazonaws.bedrock#ModelCustomizationList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ModelCustomization" + "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 24, + "max": 168 + } } }, - "com.amazonaws.bedrock#ModelDataSource": { - "type": "union", + "com.amazonaws.bedrock#ModelModality": { + "type": "enum", "members": { - "s3DataSource": { - "target": "com.amazonaws.bedrock#S3DataSource", + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + }, + "EMBEDDING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon S3 data source of the model to import.

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

The data source of the model to import.

" - } - }, - "com.amazonaws.bedrock#ModelDeploymentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,63}$" } }, - "com.amazonaws.bedrock#ModelId": { - "type": "string", - "traits": { - "smithy.api#length": { - "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})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$)|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)))|([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][_-]?)+)$" + "com.amazonaws.bedrock#ModelModalityList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelModality" } }, - "com.amazonaws.bedrock#ModelIdentifier": { + "com.amazonaws.bedrock#ModelName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 2048 + "max": 63 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([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": "^([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63})$" } }, - "com.amazonaws.bedrock#ModelImportJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1011 + "com.amazonaws.bedrock#ModelResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#GetFoundationModel" }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12}$" - } + { + "target": "com.amazonaws.bedrock#ListFoundationModels" + } + ] }, - "com.amazonaws.bedrock#ModelImportJobIdentifier": { + "com.amazonaws.bedrock#ModelSourceIdentifier": { "type": "string", "traits": { "smithy.api#length": { - "max": 1011 + "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*)$" + "smithy.api#pattern": "arn:aws:sagemaker:.*:hub-content/SageMakerPublicHub/Model/.*" } }, - "com.amazonaws.bedrock#ModelImportJobStatus": { + "com.amazonaws.bedrock#ModelStatus": { "type": "enum", "members": { - "IN_PROGRESS": { + "ACTIVE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "InProgress" + "smithy.api#enumValue": "Active" } }, - "COMPLETED": { + "CREATING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Completed" + "smithy.api#enumValue": "Creating" } }, "FAILED": { @@ -12712,1860 +17819,1905 @@ } } }, - "com.amazonaws.bedrock#ModelImportJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ModelImportJobSummary" + "com.amazonaws.bedrock#NonBlankString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" } }, - "com.amazonaws.bedrock#ModelImportJobSummary": { + "com.amazonaws.bedrock#Offer": { "type": "structure", "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelImportJobArn", + "offerId": { + "target": "com.amazonaws.bedrock#OfferId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the import job.

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

Offer Id for a model offer.

" } }, - "jobName": { - "target": "com.amazonaws.bedrock#JobName", + "offerToken": { + "target": "com.amazonaws.bedrock#OfferToken", "traits": { - "smithy.api#documentation": "

The name of the import job.

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

Offer token.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.bedrock#ModelImportJobStatus", + "termDetails": { + "target": "com.amazonaws.bedrock#TermDetails", "traits": { - "smithy.api#documentation": "

The status of the imported job.

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

Details about the terms of the offer.

", "smithy.api#required": {} } - }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", + } + }, + "traits": { + "smithy.api#documentation": "

An offer dictates usage terms for the model.

" + } + }, + "com.amazonaws.bedrock#OfferId": { + "type": "string" + }, + "com.amazonaws.bedrock#OfferToken": { + "type": "string" + }, + "com.amazonaws.bedrock#OfferType": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The time when the import job was last modified.

" + "smithy.api#enumValue": "ALL" } }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "PUBLIC": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The time import job was created.

", + "smithy.api#enumValue": "PUBLIC" + } + } + } + }, + "com.amazonaws.bedrock#Offers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#Offer" + } + }, + "com.amazonaws.bedrock#OrchestrationConfiguration": { + "type": "structure", + "members": { + "queryTransformationConfiguration": { + "target": "com.amazonaws.bedrock#QueryTransformationConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configuration details for transforming the prompt.

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

The configuration details for the model to process the prompt prior to retrieval and response generation.

" + } + }, + "com.amazonaws.bedrock#OutputDataConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", "traits": { - "smithy.api#documentation": "

The time when import job ended.

" + "smithy.api#documentation": "

The S3 URI where the output data is stored.

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

S3 Location of the output data.

" + } + }, + "com.amazonaws.bedrock#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 }, - "importedModelArn": { - "target": "com.amazonaws.bedrock#ImportedModelArn", + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrock#PerformanceConfigLatency": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The Amazon resource Name (ARN) of the imported model.

" + "smithy.api#enumValue": "standard" } }, - "importedModelName": { - "target": "com.amazonaws.bedrock#ImportedModelName", + "OPTIMIZED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The name of the imported model.

" + "smithy.api#enumValue": "optimized" + } + } + } + }, + "com.amazonaws.bedrock#PerformanceConfiguration": { + "type": "structure", + "members": { + "latency": { + "target": "com.amazonaws.bedrock#PerformanceConfigLatency", + "traits": { + "smithy.api#documentation": "

Specifies whether to use the latency-optimized or standard version of a model or inference profile.

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

Information about the import job.

" + "smithy.api#documentation": "

Contains performance settings for a model.

" } }, - "com.amazonaws.bedrock#ModelImportResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateModelImportJob" - }, - { - "target": "com.amazonaws.bedrock#DeleteImportedModel" - }, - { - "target": "com.amazonaws.bedrock#GetImportedModel" - }, - { - "target": "com.amazonaws.bedrock#GetModelImportJob" - }, - { - "target": "com.amazonaws.bedrock#ListImportedModels" - }, - { - "target": "com.amazonaws.bedrock#ListModelImportJobs" + "com.amazonaws.bedrock#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 } - ] + } }, - "com.amazonaws.bedrock#ModelInvocationIdempotencyToken": { + "com.amazonaws.bedrock#PricingTerm": { + "type": "structure", + "members": { + "rateCard": { + "target": "com.amazonaws.bedrock#RateCard", + "traits": { + "smithy.api#documentation": "

Describes a usage price for each dimension.

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

Describes the usage-based pricing term.

" + } + }, + "com.amazonaws.bedrock#PromptRouterArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 256 + "max": 2048 }, - "smithy.api#pattern": "^[a-zA-Z0-9]{1,256}(-*[a-zA-Z0-9]){0,256}$" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+$" } }, - "com.amazonaws.bedrock#ModelInvocationJobArn": { + "com.amazonaws.bedrock#PromptRouterDescription": { "type": "string", "traits": { "smithy.api#length": { - "max": 1011 + "min": 1, + "max": 200 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/[a-z0-9]{12})$" + "smithy.api#pattern": "^([0-9a-zA-Z:.][ _-]?)+$", + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrock#ModelInvocationJobIdentifier": { + "com.amazonaws.bedrock#PromptRouterName": { "type": "string", "traits": { "smithy.api#length": { - "max": 1011 + "min": 1, + "max": 64 }, - "smithy.api#pattern": "^((arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/)?[a-z0-9]{12})$" + "smithy.api#pattern": "^([0-9a-zA-Z][ _-]?)+$" } }, - "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig": { - "type": "union", + "com.amazonaws.bedrock#PromptRouterResource": { + "type": "resource", + "identifiers": { + "promptRouterArn": { + "target": "com.amazonaws.bedrock#PromptRouterArn" + } + }, + "create": { + "target": "com.amazonaws.bedrock#CreatePromptRouter" + }, + "read": { + "target": "com.amazonaws.bedrock#GetPromptRouter" + }, + "delete": { + "target": "com.amazonaws.bedrock#DeletePromptRouter" + }, + "list": { + "target": "com.amazonaws.bedrock#ListPromptRouters" + } + }, + "com.amazonaws.bedrock#PromptRouterStatus": { + "type": "enum", "members": { - "s3InputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobS3InputDataConfig", + "AVAILABLE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Contains the configuration of the S3 location of the input data.

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

Details about the location of the input to the batch inference job.

" } }, - "com.amazonaws.bedrock#ModelInvocationJobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]{1,63}(-*[a-zA-Z0-9\\+\\-\\.]){0,63}$" + "com.amazonaws.bedrock#PromptRouterSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#PromptRouterSummary" } }, - "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig": { - "type": "union", + "com.amazonaws.bedrock#PromptRouterSummary": { + "type": "structure", "members": { - "s3OutputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobS3OutputDataConfig", + "promptRouterName": { + "target": "com.amazonaws.bedrock#PromptRouterName", "traits": { - "smithy.api#documentation": "

Contains the configuration of the S3 location of the output data.

" + "smithy.api#documentation": "

The router's name.

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

Contains the configuration of the S3 location of the output data.

" - } - }, - "com.amazonaws.bedrock#ModelInvocationJobResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateModelInvocationJob" }, - { - "target": "com.amazonaws.bedrock#GetModelInvocationJob" + "routingCriteria": { + "target": "com.amazonaws.bedrock#RoutingCriteria", + "traits": { + "smithy.api#documentation": "

The router's routing criteria.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ListModelInvocationJobs" + "description": { + "target": "com.amazonaws.bedrock#PromptRouterDescription", + "traits": { + "smithy.api#documentation": "

The router's description.

" + } }, - { - "target": "com.amazonaws.bedrock#StopModelInvocationJob" - } - ] - }, - "com.amazonaws.bedrock#ModelInvocationJobS3InputDataConfig": { - "type": "structure", - "members": { - "s3InputFormat": { - "target": "com.amazonaws.bedrock#S3InputFormat", + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The format of the input data.

" + "smithy.api#documentation": "

When the router was created.

" } }, - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The S3 location of the input data.

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

When the router was updated.

" + } + }, + "promptRouterArn": { + "target": "com.amazonaws.bedrock#PromptRouterArn", + "traits": { + "smithy.api#documentation": "

The router's ARN.

", "smithy.api#required": {} } }, - "s3BucketOwner": { - "target": "com.amazonaws.bedrock#AccountId", + "models": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModels", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the S3 bucket containing the input data.

" + "smithy.api#documentation": "

The router's models.

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

Contains the configuration of the S3 location of the input data.

" - } - }, - "com.amazonaws.bedrock#ModelInvocationJobS3OutputDataConfig": { - "type": "structure", - "members": { - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", + }, + "fallbackModel": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModel", "traits": { - "smithy.api#documentation": "

The S3 location of the output data.

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

The router's fallback model.

", "smithy.api#required": {} } }, - "s3EncryptionKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", + "status": { + "target": "com.amazonaws.bedrock#PromptRouterStatus", "traits": { - "smithy.api#documentation": "

The unique identifier of the key that encrypts the S3 location of the output data.

" + "smithy.api#documentation": "

The router's status.

", + "smithy.api#required": {} } }, - "s3BucketOwner": { - "target": "com.amazonaws.bedrock#AccountId", + "type": { + "target": "com.amazonaws.bedrock#PromptRouterType", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the S3 bucket containing the output data.

" + "smithy.api#documentation": "

The summary's type.

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

Contains the configuration of the S3 location of the output data.

" + "smithy.api#documentation": "

Details about a prompt router.

" } }, - "com.amazonaws.bedrock#ModelInvocationJobStatus": { - "type": "enum", + "com.amazonaws.bedrock#PromptRouterTargetModel": { + "type": "structure", "members": { - "SUBMITTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Submitted" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", + "modelArn": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModelArn", "traits": { - "smithy.api#enumValue": "Completed" + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The target model's ARN.

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

The target model for a prompt router.

" + } + }, + "com.amazonaws.bedrock#PromptRouterTargetModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 }, - "FAILED": { + "smithy.api#pattern": "(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+)$" + } + }, + "com.amazonaws.bedrock#PromptRouterTargetModels": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#PromptRouterTargetModel" + } + }, + "com.amazonaws.bedrock#PromptRouterType": { + "type": "enum", + "members": { + "CUSTOM": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Failed" + "smithy.api#enumValue": "custom" } }, - "STOPPING": { + "DEFAULT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Stopping" + "smithy.api#enumValue": "default" } - }, - "STOPPED": { - "target": "smithy.api#Unit", + } + } + }, + "com.amazonaws.bedrock#PromptTemplate": { + "type": "structure", + "members": { + "textPromptTemplate": { + "target": "com.amazonaws.bedrock#TextPromptTemplate", "traits": { - "smithy.api#enumValue": "Stopped" + "smithy.api#documentation": "

The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.

For more information, see Knowledge base prompt template and Use XML tags with Anthropic Claude models.

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

The template for the prompt that's sent to the model for response generation.

" + } + }, + "com.amazonaws.bedrock#Provider": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9- ]{1,63}$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((([0-9a-zA-Z][_-]?)+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 }, - "PARTIALLY_COMPLETED": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelStatus": { + "type": "enum", + "members": { + "CREATING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PartiallyCompleted" + "smithy.api#enumValue": "Creating" } }, - "EXPIRED": { + "IN_SERVICE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Expired" + "smithy.api#enumValue": "InService" } }, - "VALIDATING": { + "UPDATING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Validating" + "smithy.api#enumValue": "Updating" } }, - "SCHEDULED": { + "FAILED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Scheduled" + "smithy.api#enumValue": "Failed" } } } }, - "com.amazonaws.bedrock#ModelInvocationJobSummaries": { + "com.amazonaws.bedrock#ProvisionedModelSummaries": { "type": "list", "member": { - "target": "com.amazonaws.bedrock#ModelInvocationJobSummary" + "target": "com.amazonaws.bedrock#ProvisionedModelSummary" } }, - "com.amazonaws.bedrock#ModelInvocationJobSummary": { + "com.amazonaws.bedrock#ProvisionedModelSummary": { "type": "structure", "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelInvocationJobArn", + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

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

The name of the Provisioned Throughput.

", "smithy.api#required": {} } }, - "jobName": { - "target": "com.amazonaws.bedrock#ModelInvocationJobName", + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", "traits": { - "smithy.api#documentation": "

The name of the batch inference job.

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

The Amazon Resource Name (ARN) of the Provisioned Throughput.

", "smithy.api#required": {} } }, - "modelId": { - "target": "com.amazonaws.bedrock#ModelId", + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the foundation model used for model inference.

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

The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.

", "smithy.api#required": {} } }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", + "desiredModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", "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, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.

", + "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", + "foundationModelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

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

The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", "traits": { - "smithy.api#documentation": "

The status of the batch inference job.

The following statuses are possible:

  • Submitted – This job has been submitted to a queue for validation.

  • Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:

    • Your IAM service role has access to the Amazon S3 buckets containing your files.

    • Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the modelInput value matches the request body for the model.

    • Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.

  • Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.

  • Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.

  • InProgress – This job has begun. You can start viewing the results in the output S3 location.

  • Completed – This job has successfully completed. View the output files in the output S3 location.

  • PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.

  • Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.

  • Stopped – This job was stopped by a user.

  • Stopping – This job is being stopped by a user.

" + "smithy.api#documentation": "

The number of model units allocated to the Provisioned Throughput.

", + "smithy.api#required": {} } }, - "message": { - "target": "com.amazonaws.bedrock#Message", + "desiredModelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", "traits": { - "smithy.api#documentation": "

If the batch inference job failed, this field contains a message describing why the job failed.

" + "smithy.api#documentation": "

The number of model units that was requested to be allocated to the Provisioned Throughput.

", + "smithy.api#required": {} } }, - "submitTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "status": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", "traits": { - "smithy.api#documentation": "

The time at which the batch inference job was submitted.

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

The status of the Provisioned Throughput.

", "smithy.api#required": {} } }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", "traits": { - "smithy.api#documentation": "

The time at which the batch inference job was last modified.

" + "smithy.api#documentation": "

The duration for which the Provisioned Throughput was committed.

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

The time at which the batch inference job ended.

" - } - }, - "inputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", - "traits": { - "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

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

The timestamp for when the commitment term of the Provisioned Throughput expires.

" } }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

Details about the location of the output of the batch inference job.

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

The time that the Provisioned Throughput was created.

", "smithy.api#required": {} } }, - "vpcConfig": { - "target": "com.amazonaws.bedrock#VpcConfig", - "traits": { - "smithy.api#documentation": "

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

" - } - }, - "timeoutDurationInHours": { - "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", - "traits": { - "smithy.api#documentation": "

The number of hours after which the batch inference job was set to time out.

" - } - }, - "jobExpirationTime": { + "lastModifiedTime": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

The time at which the batch inference job times or timed out.

" + "smithy.api#documentation": "

The time that the Provisioned Throughput was last modified.

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

A summary of a batch inference job.

" - } - }, - "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 24, - "max": 168 - } + "smithy.api#documentation": "

A summary of information about a Provisioned Throughput.

This data type is used in the following API operations:

" } }, - "com.amazonaws.bedrock#ModelModality": { - "type": "enum", - "members": { - "TEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEXT" - } + "com.amazonaws.bedrock#ProvisionedModelThroughputResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughput" }, - "IMAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMAGE" - } + { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughput" }, - "EMBEDDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMBEDDING" - } - } - } - }, - "com.amazonaws.bedrock#ModelModalityList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ModelModality" - } - }, - "com.amazonaws.bedrock#ModelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 + { + "target": "com.amazonaws.bedrock#GetProvisionedModelThroughput" }, - "smithy.api#pattern": "^([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63})$" - } - }, - "com.amazonaws.bedrock#ModelResource": { - "type": "resource", - "operations": [ { - "target": "com.amazonaws.bedrock#GetFoundationModel" + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputs" }, { - "target": "com.amazonaws.bedrock#ListFoundationModels" + "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughput" } ] }, - "com.amazonaws.bedrock#ModelSourceIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 + "com.amazonaws.bedrock#PutModelInvocationLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "smithy.api#pattern": "arn:aws:sagemaker:.*:hub-content/SageMakerPublicHub/Model/.*" - } - }, - "com.amazonaws.bedrock#ModelStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } + { + "target": "com.amazonaws.bedrock#InternalServerException" }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Creating" - } + { + "target": "com.amazonaws.bedrock#ThrottlingException" }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } + { + "target": "com.amazonaws.bedrock#ValidationException" } - } - }, - "com.amazonaws.bedrock#NonBlankString": { - "type": "string", + ], "traits": { - "smithy.api#pattern": "^[\\s\\S]*$" + "smithy.api#documentation": "

Set the configuration values for model invocation logging.

", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/logging/modelinvocations" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#Offer": { - "type": "structure", - "members": { - "offerId": { - "target": "com.amazonaws.bedrock#OfferId", - "traits": { - "smithy.api#documentation": "

Offer Id for a model offer.

" - } - }, - "offerToken": { - "target": "com.amazonaws.bedrock#OfferToken", - "traits": { - "smithy.api#documentation": "

Offer token.

", - "smithy.api#required": {} - } - }, - "termDetails": { - "target": "com.amazonaws.bedrock#TermDetails", + "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationRequest": { + "type": "structure", + "members": { + "loggingConfig": { + "target": "com.amazonaws.bedrock#LoggingConfig", "traits": { - "smithy.api#documentation": "

Details about the terms of the offer.

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

The logging configuration values to set.

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

An offer dictates usage terms for the model.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#OfferId": { - "type": "string" - }, - "com.amazonaws.bedrock#OfferToken": { - "type": "string" + "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - "com.amazonaws.bedrock#OfferType": { - "type": "enum", - "members": { - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } + "com.amazonaws.bedrock#PutUseCaseForModelAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#PutUseCaseForModelAccessRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#PutUseCaseForModelAccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "PUBLIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PUBLIC" - } + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Put usecase for model access.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/use-case-for-model-access" } } }, - "com.amazonaws.bedrock#Offers": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#Offer" - } - }, - "com.amazonaws.bedrock#OrchestrationConfiguration": { + "com.amazonaws.bedrock#PutUseCaseForModelAccessRequest": { "type": "structure", "members": { - "queryTransformationConfiguration": { - "target": "com.amazonaws.bedrock#QueryTransformationConfiguration", + "formData": { + "target": "com.amazonaws.bedrock#AcknowledgementFormDataBody", "traits": { - "smithy.api#documentation": "

Contains configuration details for transforming the prompt.

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

Put customer profile Request.

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

The configuration details for the model to process the prompt prior to retrieval and response generation.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#OutputDataConfig": { + "com.amazonaws.bedrock#PutUseCaseForModelAccessResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#QueryTransformationConfiguration": { "type": "structure", "members": { - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", + "type": { + "target": "com.amazonaws.bedrock#QueryTransformationType", "traits": { - "smithy.api#documentation": "

The S3 URI where the output data is stored.

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

The type of transformation to apply to the prompt.

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

S3 Location of the output data.

" - } - }, - "com.amazonaws.bedrock#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^\\S*$" + "smithy.api#documentation": "

The configuration details for transforming the prompt.

" } }, - "com.amazonaws.bedrock#PerformanceConfigLatency": { + "com.amazonaws.bedrock#QueryTransformationType": { "type": "enum", "members": { - "STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "standard" - } - }, - "OPTIMIZED": { + "QUERY_DECOMPOSITION": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "optimized" + "smithy.api#enumValue": "QUERY_DECOMPOSITION" } } } }, - "com.amazonaws.bedrock#PerformanceConfiguration": { - "type": "structure", + "com.amazonaws.bedrock#RAGConfig": { + "type": "union", "members": { - "latency": { - "target": "com.amazonaws.bedrock#PerformanceConfigLatency", + "knowledgeBaseConfig": { + "target": "com.amazonaws.bedrock#KnowledgeBaseConfig", "traits": { - "smithy.api#documentation": "

Specifies whether to use the latency-optimized or standard version of a model or inference profile.

" + "smithy.api#documentation": "

Contains configuration details for knowledge base retrieval and response generation.

" + } + }, + "precomputedRagSourceConfig": { + "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceConfig", + "traits": { + "smithy.api#documentation": "

Contains configuration details about the RAG source used to generate inference response data for a Knowledge Base evaluation job.

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

Contains performance settings for a model.

" - } - }, - "com.amazonaws.bedrock#PositiveInteger": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } + "smithy.api#documentation": "

Contains configuration details for retrieval of information and response generation.

" } }, - "com.amazonaws.bedrock#PricingTerm": { - "type": "structure", - "members": { - "rateCard": { - "target": "com.amazonaws.bedrock#RateCard", - "traits": { - "smithy.api#documentation": "

Describes a usage price for each dimension.

", - "smithy.api#required": {} + "com.amazonaws.bedrock#RAGStopSequences": { + "type": "list", + "member": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 } } }, "traits": { - "smithy.api#documentation": "

Describes the usage-based pricing term.

" + "smithy.api#length": { + "min": 0, + "max": 4 + } } }, - "com.amazonaws.bedrock#PromptRouterArn": { - "type": "string", + "com.amazonaws.bedrock#RagConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#RAGConfig" + }, "traits": { "smithy.api#length": { "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+$" + "max": 1 + } } }, - "com.amazonaws.bedrock#PromptRouterDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#pattern": "^([0-9a-zA-Z:.][ _-]?)+$", - "smithy.api#sensitive": {} + "com.amazonaws.bedrock#RateCard": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#DimensionalPriceRate" } }, - "com.amazonaws.bedrock#PromptRouterName": { - "type": "string", + "com.amazonaws.bedrock#RatingScale": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#RatingScaleItem" + }, "traits": { "smithy.api#length": { "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^([0-9a-zA-Z][ _-]?)+$" - } - }, - "com.amazonaws.bedrock#PromptRouterResource": { - "type": "resource", - "identifiers": { - "promptRouterArn": { - "target": "com.amazonaws.bedrock#PromptRouterArn" + "max": 10 } - }, - "create": { - "target": "com.amazonaws.bedrock#CreatePromptRouter" - }, - "read": { - "target": "com.amazonaws.bedrock#GetPromptRouter" - }, - "delete": { - "target": "com.amazonaws.bedrock#DeletePromptRouter" - }, - "list": { - "target": "com.amazonaws.bedrock#ListPromptRouters" } }, - "com.amazonaws.bedrock#PromptRouterStatus": { - "type": "enum", + "com.amazonaws.bedrock#RatingScaleItem": { + "type": "structure", "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", + "definition": { + "target": "com.amazonaws.bedrock#RatingScaleItemDefinition", "traits": { - "smithy.api#enumValue": "AVAILABLE" + "smithy.api#documentation": "

Defines the definition for one rating in a custom metric rating scale.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrock#RatingScaleItemValue", + "traits": { + "smithy.api#documentation": "

Defines the value for one rating in a custom metric rating scale.

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

Defines the value and corresponding definition for one rating in a custom metric rating scale.

" } }, - "com.amazonaws.bedrock#PromptRouterSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#PromptRouterSummary" + "com.amazonaws.bedrock#RatingScaleItemDefinition": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } } }, - "com.amazonaws.bedrock#PromptRouterSummary": { - "type": "structure", + "com.amazonaws.bedrock#RatingScaleItemValue": { + "type": "union", "members": { - "promptRouterName": { - "target": "com.amazonaws.bedrock#PromptRouterName", + "stringValue": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The router's name.

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

A string representing the value for a rating in a custom metric rating scale.

", + "smithy.api#length": { + "min": 1, + "max": 100 + } } }, - "routingCriteria": { - "target": "com.amazonaws.bedrock#RoutingCriteria", + "floatValue": { + "target": "smithy.api#Float", "traits": { - "smithy.api#documentation": "

The router's routing criteria.

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

A floating point number representing the value for a rating in a custom metric rating scale.

" } - }, - "description": { - "target": "com.amazonaws.bedrock#PromptRouterDescription", + } + }, + "traits": { + "smithy.api#documentation": "

Defines the value for one rating in a custom metric rating scale.

" + } + }, + "com.amazonaws.bedrock#RegionAvailability": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The router's description.

" + "smithy.api#enumValue": "AVAILABLE" } }, - "createdAt": { - "target": "com.amazonaws.bedrock#Timestamp", + "NOT_AVAILABLE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

When the router was created.

" + "smithy.api#enumValue": "NOT_AVAILABLE" } + } + } + }, + "com.amazonaws.bedrock#RegisterMarketplaceModelEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#RegisterMarketplaceModelEndpointRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#RegisterMarketplaceModelEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "updatedAt": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

When the router was updated.

" - } + { + "target": "com.amazonaws.bedrock#InternalServerException" }, - "promptRouterArn": { - "target": "com.amazonaws.bedrock#PromptRouterArn", - "traits": { - "smithy.api#documentation": "

The router's ARN.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, - "models": { - "target": "com.amazonaws.bedrock#PromptRouterTargetModels", - "traits": { - "smithy.api#documentation": "

The router's models.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.bedrock#ServiceUnavailableException" }, - "fallbackModel": { - "target": "com.amazonaws.bedrock#PromptRouterTargetModel", - "traits": { - "smithy.api#documentation": "

The router's fallback model.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.bedrock#ThrottlingException" }, - "status": { - "target": "com.amazonaws.bedrock#PromptRouterStatus", + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/marketplace-model/endpoints/{endpointIdentifier}/registration" + } + } + }, + "com.amazonaws.bedrock#RegisterMarketplaceModelEndpointRequest": { + "type": "structure", + "members": { + "endpointIdentifier": { + "target": "com.amazonaws.bedrock#Arn", "traits": { - "smithy.api#documentation": "

The router's status.

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

The ARN of the Amazon SageMaker endpoint you want to register with Amazon Bedrock Marketplace.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "type": { - "target": "com.amazonaws.bedrock#PromptRouterType", + "modelSourceIdentifier": { + "target": "com.amazonaws.bedrock#ModelSourceIdentifier", "traits": { - "smithy.api#documentation": "

The summary's type.

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

The ARN of the model from Amazon Bedrock Marketplace that is deployed on the endpoint.

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

Details about a prompt router.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#PromptRouterTargetModel": { + "com.amazonaws.bedrock#RegisterMarketplaceModelEndpointResponse": { "type": "structure", "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#PromptRouterTargetModelArn", + "marketplaceModelEndpoint": { + "target": "com.amazonaws.bedrock#MarketplaceModelEndpoint", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The target model's ARN.

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

Details about the registered endpoint.

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

The target model for a prompt router.

" - } - }, - "com.amazonaws.bedrock#PromptRouterTargetModelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+)$" - } - }, - "com.amazonaws.bedrock#PromptRouterTargetModels": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#PromptRouterTargetModel" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#PromptRouterType": { - "type": "enum", + "com.amazonaws.bedrock#RequestMetadataBaseFilters": { + "type": "structure", "members": { - "CUSTOM": { - "target": "smithy.api#Unit", + "equals": { + "target": "com.amazonaws.bedrock#RequestMetadataMap", "traits": { - "smithy.api#enumValue": "custom" + "smithy.api#documentation": "

Include results where the key equals the value.

" } }, - "DEFAULT": { - "target": "smithy.api#Unit", + "notEquals": { + "target": "com.amazonaws.bedrock#RequestMetadataMap", "traits": { - "smithy.api#enumValue": "default" + "smithy.api#documentation": "

Include results where the key does not equal the value.

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

A mapping of a metadata key to a value that it should or should not equal.

" } }, - "com.amazonaws.bedrock#PromptTemplate": { - "type": "structure", + "com.amazonaws.bedrock#RequestMetadataFilters": { + "type": "union", "members": { - "textPromptTemplate": { - "target": "com.amazonaws.bedrock#TextPromptTemplate", + "equals": { + "target": "com.amazonaws.bedrock#RequestMetadataMap", "traits": { - "smithy.api#documentation": "

The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.

For more information, see Knowledge base prompt template and Use XML tags with Anthropic Claude models.

" + "smithy.api#documentation": "

Include results where the key equals the value.

" + } + }, + "notEquals": { + "target": "com.amazonaws.bedrock#RequestMetadataMap", + "traits": { + "smithy.api#documentation": "

Include results where the key does not equal the value.

" + } + }, + "andAll": { + "target": "com.amazonaws.bedrock#RequestMetadataFiltersList", + "traits": { + "smithy.api#documentation": "

Include results where all of the based filters match.

" + } + }, + "orAll": { + "target": "com.amazonaws.bedrock#RequestMetadataFiltersList", + "traits": { + "smithy.api#documentation": "

Include results where any of the base filters match.

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

The template for the prompt that's sent to the model for response generation.

" - } - }, - "com.amazonaws.bedrock#Provider": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[A-Za-z0-9- ]{1,63}$" - } - }, - "com.amazonaws.bedrock#ProvisionedModelArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}$" + "smithy.api#documentation": "

Rules for filtering invocation logs. A filter can be a mapping of a metadata key to a value that it should or should not equal (a base filter), or a list of base filters that are all applied with AND or OR logical operators

" } }, - "com.amazonaws.bedrock#ProvisionedModelId": { - "type": "string", + "com.amazonaws.bedrock#RequestMetadataFiltersList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#RequestMetadataBaseFilters" + }, "traits": { - "smithy.api#pattern": "^((([0-9a-zA-Z][_-]?)+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$" + "smithy.api#length": { + "min": 1, + "max": 16 + } } }, - "com.amazonaws.bedrock#ProvisionedModelName": { - "type": "string", + "com.amazonaws.bedrock#RequestMetadataMap": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+$@-]{1,256}$" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+$@-]{0,256}$" + } + }, "traits": { "smithy.api#length": { "min": 1, - "max": 63 + "max": 1 }, - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrock#ProvisionedModelStatus": { + "com.amazonaws.bedrock#RerankingMetadataSelectionMode": { "type": "enum", "members": { - "CREATING": { + "SELECTIVE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Creating" + "smithy.api#enumValue": "SELECTIVE" } }, - "IN_SERVICE": { + "ALL": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "InService" + "smithy.api#enumValue": "ALL" } - }, - "UPDATING": { - "target": "smithy.api#Unit", + } + } + }, + "com.amazonaws.bedrock#RerankingMetadataSelectiveModeConfiguration": { + "type": "union", + "members": { + "fieldsToInclude": { + "target": "com.amazonaws.bedrock#FieldsForReranking", "traits": { - "smithy.api#enumValue": "Updating" + "smithy.api#documentation": "

A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.

" } }, - "FAILED": { - "target": "smithy.api#Unit", + "fieldsToExclude": { + "target": "com.amazonaws.bedrock#FieldsForReranking", "traits": { - "smithy.api#enumValue": "Failed" + "smithy.api#documentation": "

A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.

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

Configuration for selectively including or excluding metadata fields during the reranking process. This allows you to control which metadata attributes are considered when reordering search results.

" } }, - "com.amazonaws.bedrock#ProvisionedModelSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ProvisionedModelSummary" + "com.amazonaws.bedrock#ResourceInUseException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "

Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 } }, - "com.amazonaws.bedrock#ProvisionedModelSummary": { + "com.amazonaws.bedrock#ResourceNotFoundException": { "type": "structure", "members": { - "provisionedModelName": { - "target": "com.amazonaws.bedrock#ProvisionedModelName", - "traits": { - "smithy.api#documentation": "

The name of the Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "provisionedModelArn": { - "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bedrock#RetrievalFilter": { + "type": "union", + "members": { + "equals": { + "target": "com.amazonaws.bedrock#FilterAttribute", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Provisioned Throughput.

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

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.

The following example would return data sources with an animal attribute whose value is 'cat': \"equals\": { \"key\": \"animal\", \"value\": \"cat\" }

" } }, - "modelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + "notEquals": { + "target": "com.amazonaws.bedrock#FilterAttribute", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.

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

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.

The following example would return data sources that don't contain an animal attribute whose value is 'cat': \"notEquals\": { \"key\": \"animal\", \"value\": \"cat\" }

" } }, - "desiredModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", + "greaterThan": { + "target": "com.amazonaws.bedrock#FilterAttribute", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.

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

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.

The following example would return data sources with an year attribute whose value is greater than '1989': \"greaterThan\": { \"key\": \"year\", \"value\": 1989 }

" } }, - "foundationModelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", + "greaterThanOrEquals": { + "target": "com.amazonaws.bedrock#FilterAttribute", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.

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

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.

The following example would return data sources with an year attribute whose value is greater than or equal to '1989': \"greaterThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }

" } }, - "modelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", + "lessThan": { + "target": "com.amazonaws.bedrock#FilterAttribute", "traits": { - "smithy.api#documentation": "

The number of model units allocated to the Provisioned Throughput.

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

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.

The following example would return data sources with an year attribute whose value is less than to '1989': \"lessThan\": { \"key\": \"year\", \"value\": 1989 }

" } }, - "desiredModelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", + "lessThanOrEquals": { + "target": "com.amazonaws.bedrock#FilterAttribute", "traits": { - "smithy.api#documentation": "

The number of model units that was requested to be allocated to the Provisioned Throughput.

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

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.

The following example would return data sources with an year attribute whose value is less than or equal to '1989': \"lessThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }

" } }, - "status": { - "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "in": { + "target": "com.amazonaws.bedrock#FilterAttribute", "traits": { - "smithy.api#documentation": "

The status of the Provisioned Throughput.

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

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.

The following example would return data sources with an animal attribute that is either 'cat' or 'dog': \"in\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }

" } }, - "commitmentDuration": { - "target": "com.amazonaws.bedrock#CommitmentDuration", + "notIn": { + "target": "com.amazonaws.bedrock#FilterAttribute", "traits": { - "smithy.api#documentation": "

The duration for which the Provisioned Throughput was committed.

" + "smithy.api#documentation": "

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.

The following example would return data sources whose animal attribute is neither 'cat' nor 'dog': \"notIn\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }

" } }, - "commitmentExpirationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "startsWith": { + "target": "com.amazonaws.bedrock#FilterAttribute", "traits": { - "smithy.api#documentation": "

The timestamp for when the commitment term of the Provisioned Throughput expires.

" + "smithy.api#documentation": "

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.

The following example would return data sources with an animal attribute starts with 'ca' (for example, 'cat' or 'camel'). \"startsWith\": { \"key\": \"animal\", \"value\": \"ca\" }

" } }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "listContains": { + "target": "com.amazonaws.bedrock#FilterAttribute", "traits": { - "smithy.api#documentation": "

The time that the Provisioned Throughput was created.

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

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.

The following example would return data sources with an animals attribute that is a list containing a cat member (for example, [\"dog\", \"cat\"]): \"listContains\": { \"key\": \"animals\", \"value\": \"cat\" }

" } }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "stringContains": { + "target": "com.amazonaws.bedrock#FilterAttribute", "traits": { - "smithy.api#documentation": "

The time that the Provisioned Throughput was last modified.

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

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:

A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example, 'cat'): \"stringContains\": { \"key\": \"animal\", \"value\": \"at\" }

A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example, [\"dog\", \"cat\"]): \"stringContains\": { \"key\": \"animals\", \"value\": \"at\" }

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

A summary of information about a Provisioned Throughput.

This data type is used in the following API operations:

" - } - }, - "com.amazonaws.bedrock#ProvisionedModelThroughputResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughput" - }, - { - "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughput" - }, - { - "target": "com.amazonaws.bedrock#GetProvisionedModelThroughput" - }, - { - "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputs" - }, - { - "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughput" - } - ] - }, - "com.amazonaws.bedrock#PutModelInvocationLoggingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Set the configuration values for model invocation logging.

", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/logging/modelinvocations" }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationRequest": { - "type": "structure", - "members": { - "loggingConfig": { - "target": "com.amazonaws.bedrock#LoggingConfig", + "andAll": { + "target": "com.amazonaws.bedrock#RetrievalFilterList", "traits": { - "smithy.api#documentation": "

The logging configuration values to set.

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

Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

" } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#PutUseCaseForModelAccess": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#PutUseCaseForModelAccessRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#PutUseCaseForModelAccessResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Put usecase for model access.

", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/use-case-for-model-access" - } - } - }, - "com.amazonaws.bedrock#PutUseCaseForModelAccessRequest": { - "type": "structure", - "members": { - "formData": { - "target": "com.amazonaws.bedrock#AcknowledgementFormDataBody", + "orAll": { + "target": "com.amazonaws.bedrock#RetrievalFilterList", "traits": { - "smithy.api#documentation": "

Put customer profile Request.

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

Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

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

Specifies the filters to use on the metadata attributes/fields in the knowledge base data sources before returning results.

", + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrock#PutUseCaseForModelAccessResponse": { - "type": "structure", - "members": {}, + "com.amazonaws.bedrock#RetrievalFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#RetrievalFilter" + }, "traits": { - "smithy.api#output": {} + "smithy.api#length": { + "min": 2 + } } }, - "com.amazonaws.bedrock#QueryTransformationConfiguration": { + "com.amazonaws.bedrock#RetrieveAndGenerateConfiguration": { "type": "structure", "members": { "type": { - "target": "com.amazonaws.bedrock#QueryTransformationType", + "target": "com.amazonaws.bedrock#RetrieveAndGenerateType", "traits": { - "smithy.api#documentation": "

The type of transformation to apply to the prompt.

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

The type of resource that contains your data for retrieving information and generating responses.

If you choose to use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

", "smithy.api#required": {} } + }, + "knowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrock#KnowledgeBaseRetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configuration details for the knowledge base retrieval and response generation.

" + } + }, + "externalSourcesConfiguration": { + "target": "com.amazonaws.bedrock#ExternalSourcesRetrieveAndGenerateConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the external source wrapper object in the retrieveAndGenerate function.

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

The configuration details for transforming the prompt.

" + "smithy.api#documentation": "

Contains configuration details for a knowledge base retrieval and response generation.

" } }, - "com.amazonaws.bedrock#QueryTransformationType": { + "com.amazonaws.bedrock#RetrieveAndGenerateType": { "type": "enum", "members": { - "QUERY_DECOMPOSITION": { + "KNOWLEDGE_BASE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "QUERY_DECOMPOSITION" + "smithy.api#enumValue": "KNOWLEDGE_BASE" + } + }, + "EXTERNAL_SOURCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTERNAL_SOURCES" } } } }, - "com.amazonaws.bedrock#RAGConfig": { - "type": "union", + "com.amazonaws.bedrock#RetrieveConfig": { + "type": "structure", "members": { - "knowledgeBaseConfig": { - "target": "com.amazonaws.bedrock#KnowledgeBaseConfig", + "knowledgeBaseId": { + "target": "com.amazonaws.bedrock#KnowledgeBaseId", "traits": { - "smithy.api#documentation": "

Contains configuration details for knowledge base retrieval and response generation.

" + "smithy.api#documentation": "

The unique identifier of the knowledge base.

", + "smithy.api#required": {} } }, - "precomputedRagSourceConfig": { - "target": "com.amazonaws.bedrock#EvaluationPrecomputedRagSourceConfig", + "knowledgeBaseRetrievalConfiguration": { + "target": "com.amazonaws.bedrock#KnowledgeBaseRetrievalConfiguration", "traits": { - "smithy.api#documentation": "

Contains configuration details about the RAG source used to generate inference response data for a Knowledge Base evaluation job.

" + "smithy.api#documentation": "

Contains configuration details for knowledge base retrieval.

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

Contains configuration details for retrieval of information and response generation.

" + "smithy.api#documentation": "

The configuration details for retrieving information from a knowledge base.

" } }, - "com.amazonaws.bedrock#RAGStopSequences": { - "type": "list", - "member": { - "target": "smithy.api#String", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, + "com.amazonaws.bedrock#RoleArn": { + "type": "string", "traits": { + "smithy.api#documentation": "ARN of a IAM role", "smithy.api#length": { - "min": 0, - "max": 4 - } + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" } }, - "com.amazonaws.bedrock#RagConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#RAGConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 + "com.amazonaws.bedrock#RoutingCriteria": { + "type": "structure", + "members": { + "responseQualityDifference": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The criteria's response quality difference.

", + "smithy.api#range": { + "min": 0, + "max": 100 + }, + "smithy.api#required": {} + } } - } - }, - "com.amazonaws.bedrock#RateCard": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#DimensionalPriceRate" - } - }, - "com.amazonaws.bedrock#RatingScale": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#RatingScaleItem" }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } + "smithy.api#documentation": "

Routing criteria for a prompt router.

" } }, - "com.amazonaws.bedrock#RatingScaleItem": { + "com.amazonaws.bedrock#S3Config": { "type": "structure", "members": { - "definition": { - "target": "com.amazonaws.bedrock#RatingScaleItemDefinition", + "bucketName": { + "target": "com.amazonaws.bedrock#BucketName", "traits": { - "smithy.api#documentation": "

Defines the definition for one rating in a custom metric rating scale.

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

S3 bucket name.

", "smithy.api#required": {} } }, - "value": { - "target": "com.amazonaws.bedrock#RatingScaleItemValue", + "keyPrefix": { + "target": "com.amazonaws.bedrock#KeyPrefix", "traits": { - "smithy.api#documentation": "

Defines the value for one rating in a custom metric rating scale.

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

S3 prefix.

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

Defines the value and corresponding definition for one rating in a custom metric rating scale.

" - } - }, - "com.amazonaws.bedrock#RatingScaleItemDefinition": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } + "smithy.api#documentation": "

S3 configuration for storing log data.

" } }, - "com.amazonaws.bedrock#RatingScaleItemValue": { - "type": "union", + "com.amazonaws.bedrock#S3DataSource": { + "type": "structure", "members": { - "stringValue": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

A string representing the value for a rating in a custom metric rating scale.

", - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "floatValue": { - "target": "smithy.api#Float", + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", "traits": { - "smithy.api#documentation": "

A floating point number representing the value for a rating in a custom metric rating scale.

" + "smithy.api#documentation": "

The URI of the Amazon S3 data source.

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

Defines the value for one rating in a custom metric rating scale.

" + "smithy.api#documentation": "

The Amazon S3 data source of the model to import.

" } }, - "com.amazonaws.bedrock#RegionAvailability": { + "com.amazonaws.bedrock#S3InputFormat": { "type": "enum", "members": { - "AVAILABLE": { + "JSONL": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "AVAILABLE" + "smithy.api#enumValue": "JSONL" } - }, - "NOT_AVAILABLE": { - "target": "smithy.api#Unit", + } + } + }, + "com.amazonaws.bedrock#S3ObjectDoc": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrock#kBS3Uri", "traits": { - "smithy.api#enumValue": "NOT_AVAILABLE" + "smithy.api#documentation": "

The S3 URI location for the wrapper object of the document.

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

The unique wrapper object of the document from the S3 location.

" } }, - "com.amazonaws.bedrock#RegisterMarketplaceModelEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#RegisterMarketplaceModelEndpointRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#RegisterMarketplaceModelEndpointResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], + "com.amazonaws.bedrock#S3Uri": { + "type": "string", "traits": { - "smithy.api#documentation": "

Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/marketplace-model/endpoints/{endpointIdentifier}/registration" - } + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?$" } }, - "com.amazonaws.bedrock#RegisterMarketplaceModelEndpointRequest": { + "com.amazonaws.bedrock#SageMakerEndpoint": { "type": "structure", "members": { - "endpointIdentifier": { - "target": "com.amazonaws.bedrock#Arn", + "initialInstanceCount": { + "target": "com.amazonaws.bedrock#InstanceCount", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon SageMaker endpoint you want to register with Amazon Bedrock Marketplace.

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

The number of Amazon EC2 compute instances to deploy for initial endpoint creation.

", "smithy.api#required": {} } }, - "modelSourceIdentifier": { - "target": "com.amazonaws.bedrock#ModelSourceIdentifier", + "instanceType": { + "target": "com.amazonaws.bedrock#InstanceType", "traits": { - "smithy.api#documentation": "

The ARN of the model from Amazon Bedrock Marketplace that is deployed on the endpoint.

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

The Amazon EC2 compute instance type to deploy for hosting the model.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#RegisterMarketplaceModelEndpointResponse": { - "type": "structure", - "members": { - "marketplaceModelEndpoint": { - "target": "com.amazonaws.bedrock#MarketplaceModelEndpoint", + }, + "executionRole": { + "target": "com.amazonaws.bedrock#RoleArn", "traits": { - "smithy.api#documentation": "

Details about the registered endpoint.

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

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on Amazon EC2 compute instances or for batch transform jobs.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#RequestMetadataBaseFilters": { - "type": "structure", - "members": { - "equals": { - "target": "com.amazonaws.bedrock#RequestMetadataMap", + }, + "kmsEncryptionKey": { + "target": "com.amazonaws.bedrock#KmsKeyId", "traits": { - "smithy.api#documentation": "

Include results where the key equals the value.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the Amazon EC2 compute instance that hosts the endpoint.

" } }, - "notEquals": { - "target": "com.amazonaws.bedrock#RequestMetadataMap", + "vpc": { + "target": "com.amazonaws.bedrock#VpcConfig", "traits": { - "smithy.api#documentation": "

Include results where the key does not equal the value.

" + "smithy.api#documentation": "

The VPC configuration for the endpoint.

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

A mapping of a metadata key to a value that it should or should not equal.

" + "smithy.api#documentation": "

Specifies the configuration for a Amazon SageMaker endpoint.

" } }, - "com.amazonaws.bedrock#RequestMetadataFilters": { - "type": "union", - "members": { - "equals": { - "target": "com.amazonaws.bedrock#RequestMetadataMap", - "traits": { - "smithy.api#documentation": "

Include results where the key equals the value.

" - } - }, - "notEquals": { - "target": "com.amazonaws.bedrock#RequestMetadataMap", - "traits": { - "smithy.api#documentation": "

Include results where the key does not equal the value.

" - } + "com.amazonaws.bedrock#SageMakerFlowDefinitionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 }, - "andAll": { - "target": "com.amazonaws.bedrock#RequestMetadataFiltersList", + "smithy.api#pattern": "^arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:flow-definition/.*$" + } + }, + "com.amazonaws.bedrock#SearchType": { + "type": "enum", + "members": { + "HYBRID": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Include results where all of the based filters match.

" + "smithy.api#enumValue": "HYBRID" } }, - "orAll": { - "target": "com.amazonaws.bedrock#RequestMetadataFiltersList", + "SEMANTIC": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Include results where any of the base filters match.

" + "smithy.api#enumValue": "SEMANTIC" } } - }, + } + }, + "com.amazonaws.bedrock#SecurityGroupId": { + "type": "string", "traits": { - "smithy.api#documentation": "

Rules for filtering invocation logs. A filter can be a mapping of a metadata key to a value that it should or should not equal (a base filter), or a list of base filters that are all applied with AND or OR logical operators

" + "smithy.api#length": { + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" } }, - "com.amazonaws.bedrock#RequestMetadataFiltersList": { + "com.amazonaws.bedrock#SecurityGroupIds": { "type": "list", "member": { - "target": "com.amazonaws.bedrock#RequestMetadataBaseFilters" + "target": "com.amazonaws.bedrock#SecurityGroupId" }, "traits": { "smithy.api#length": { "min": 1, - "max": 16 + "max": 5 } } }, - "com.amazonaws.bedrock#RequestMetadataMap": { - "type": "map", - "key": { - "target": "smithy.api#String", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+$@-]{1,256}$" + "com.amazonaws.bedrock#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" } }, - "value": { - "target": "smithy.api#String", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+$@-]{0,256}$" + "traits": { + "smithy.api#documentation": "

The number of requests exceeds the service quota. Resubmit your request later.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrock#ServiceUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" } }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - }, - "smithy.api#sensitive": {} + "smithy.api#documentation": "

Returned if the service cannot complete the request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 503 } }, - "com.amazonaws.bedrock#RerankingMetadataSelectionMode": { + "com.amazonaws.bedrock#SortByProvisionedModels": { "type": "enum", "members": { - "SELECTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SELECTIVE" - } - }, - "ALL": { + "CREATION_TIME": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ALL" + "smithy.api#enumValue": "CreationTime" } } } }, - "com.amazonaws.bedrock#RerankingMetadataSelectiveModeConfiguration": { - "type": "union", + "com.amazonaws.bedrock#SortJobsBy": { + "type": "enum", "members": { - "fieldsToInclude": { - "target": "com.amazonaws.bedrock#FieldsForReranking", - "traits": { - "smithy.api#documentation": "

A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.

" - } - }, - "fieldsToExclude": { - "target": "com.amazonaws.bedrock#FieldsForReranking", + "CREATION_TIME": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.

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

Configuration for selectively including or excluding metadata fields during the reranking process. This allows you to control which metadata attributes are considered when reordering search results.

" } }, - "com.amazonaws.bedrock#ResourceNotFoundException": { - "type": "structure", + "com.amazonaws.bedrock#SortModelsBy": { + "type": "enum", "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } } - }, - "traits": { - "smithy.api#documentation": "

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 } }, - "com.amazonaws.bedrock#RetrievalFilter": { - "type": "union", + "com.amazonaws.bedrock#SortOrder": { + "type": "enum", "members": { - "equals": { - "target": "com.amazonaws.bedrock#FilterAttribute", + "ASCENDING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.

The following example would return data sources with an animal attribute whose value is 'cat': \"equals\": { \"key\": \"animal\", \"value\": \"cat\" }

" + "smithy.api#enumValue": "Ascending" } }, - "notEquals": { - "target": "com.amazonaws.bedrock#FilterAttribute", + "DESCENDING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.

The following example would return data sources that don't contain an animal attribute whose value is 'cat': \"notEquals\": { \"key\": \"animal\", \"value\": \"cat\" }

" + "smithy.api#enumValue": "Descending" } + } + } + }, + "com.amazonaws.bedrock#StartAutomatedReasoningPolicyBuildWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StartAutomatedReasoningPolicyBuildWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StartAutomatedReasoningPolicyBuildWorkflowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "greaterThan": { - "target": "com.amazonaws.bedrock#FilterAttribute", - "traits": { - "smithy.api#documentation": "

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.

The following example would return data sources with an year attribute whose value is greater than '1989': \"greaterThan\": { \"key\": \"year\", \"value\": 1989 }

" - } + { + "target": "com.amazonaws.bedrock#ConflictException" }, - "greaterThanOrEquals": { - "target": "com.amazonaws.bedrock#FilterAttribute", - "traits": { - "smithy.api#documentation": "

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.

The following example would return data sources with an year attribute whose value is greater than or equal to '1989': \"greaterThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }

" - } + { + "target": "com.amazonaws.bedrock#InternalServerException" }, - "lessThan": { - "target": "com.amazonaws.bedrock#FilterAttribute", - "traits": { - "smithy.api#documentation": "

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.

The following example would return data sources with an year attribute whose value is less than to '1989': \"lessThan\": { \"key\": \"year\", \"value\": 1989 }

" - } + { + "target": "com.amazonaws.bedrock#ResourceInUseException" }, - "lessThanOrEquals": { - "target": "com.amazonaws.bedrock#FilterAttribute", - "traits": { - "smithy.api#documentation": "

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.

The following example would return data sources with an year attribute whose value is less than or equal to '1989': \"lessThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }

" - } + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, - "in": { - "target": "com.amazonaws.bedrock#FilterAttribute", - "traits": { - "smithy.api#documentation": "

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.

The following example would return data sources with an animal attribute that is either 'cat' or 'dog': \"in\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }

" - } + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" }, - "notIn": { - "target": "com.amazonaws.bedrock#FilterAttribute", + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a new build workflow for an Automated Reasoning policy. This initiates the process of analyzing source documents and generating policy rules, variables, and types.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowType}/start" + } + } + }, + "com.amazonaws.bedrock#StartAutomatedReasoningPolicyBuildWorkflowRequest": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.

The following example would return data sources whose animal attribute is neither 'cat' nor 'dog': \"notIn\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to start the build workflow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "startsWith": { - "target": "com.amazonaws.bedrock#FilterAttribute", + "buildWorkflowType": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowType", "traits": { - "smithy.api#documentation": "

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.

The following example would return data sources with an animal attribute starts with 'ca' (for example, 'cat' or 'camel'). \"startsWith\": { \"key\": \"animal\", \"value\": \"ca\" }

" + "smithy.api#documentation": "

The type of build workflow to start (e.g., DOCUMENT_INGESTION for processing new documents, POLICY_REPAIR for fixing existing policies).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "listContains": { - "target": "com.amazonaws.bedrock#FilterAttribute", + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.

The following example would return data sources with an animals attribute that is a list containing a cat member (for example, [\"dog\", \"cat\"]): \"listContains\": { \"key\": \"animals\", \"value\": \"cat\" }

" + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the operation completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error.

", + "smithy.api#httpHeader": "x-amz-client-token", + "smithy.api#idempotencyToken": {} } }, - "stringContains": { - "target": "com.amazonaws.bedrock#FilterAttribute", + "sourceContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowSource", "traits": { - "smithy.api#documentation": "

Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:

A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example, 'cat'): \"stringContains\": { \"key\": \"animal\", \"value\": \"at\" }

A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example, [\"dog\", \"cat\"]): \"stringContains\": { \"key\": \"animals\", \"value\": \"at\" }

" + "smithy.api#documentation": "

The source content for the build workflow, such as documents to analyze or repair instructions for existing policies.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} } - }, - "andAll": { - "target": "com.amazonaws.bedrock#RetrievalFilterList", + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] + } + }, + "com.amazonaws.bedrock#StartAutomatedReasoningPolicyBuildWorkflowResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy.

", + "smithy.api#required": {} } }, - "orAll": { - "target": "com.amazonaws.bedrock#RetrievalFilterList", + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", "traits": { - "smithy.api#documentation": "

Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

" + "smithy.api#documentation": "

The unique identifier of the newly started build workflow. Use this ID to track the workflow's progress and retrieve its results.

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

Specifies the filters to use on the metadata attributes/fields in the knowledge base data sources before returning results.

", - "smithy.api#sensitive": {} + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] } }, - "com.amazonaws.bedrock#RetrievalFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#RetrievalFilter" + "com.amazonaws.bedrock#StartAutomatedReasoningPolicyTestWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StartAutomatedReasoningPolicyTestWorkflowRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StartAutomatedReasoningPolicyTestWorkflowResponse" }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceInUseException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "min": 2 + "smithy.api#documentation": "

Initiates a test workflow to validate Automated Reasoning policy tests. The workflow executes the specified tests against the policy and generates validation results.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/test-workflows" } } }, - "com.amazonaws.bedrock#RetrieveAndGenerateConfiguration": { + "com.amazonaws.bedrock#StartAutomatedReasoningPolicyTestWorkflowRequest": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.bedrock#RetrieveAndGenerateType", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

The type of resource that contains your data for retrieving information and generating responses.

If you choose to use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

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

The Amazon Resource Name (ARN) of the Automated Reasoning policy to test.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "knowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrock#KnowledgeBaseRetrieveAndGenerateConfiguration", + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", "traits": { - "smithy.api#documentation": "

Contains configuration details for the knowledge base retrieval and response generation.

" + "smithy.api#documentation": "

The build workflow identifier. The build workflow must show a COMPLETED status before running tests.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "externalSourcesConfiguration": { - "target": "com.amazonaws.bedrock#ExternalSourcesRetrieveAndGenerateConfiguration", + "testCaseIds": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseIdList", "traits": { - "smithy.api#documentation": "

The configuration for the external source wrapper object in the retrieveAndGenerate function.

" + "smithy.api#documentation": "

The list of test identifiers to run. If not provided, all tests for the policy are run.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error.

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

Contains configuration details for a knowledge base retrieval and response generation.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#RetrieveAndGenerateType": { + "com.amazonaws.bedrock#StartAutomatedReasoningPolicyTestWorkflowResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy for which the test workflow was started.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#Status": { "type": "enum", "members": { - "KNOWLEDGE_BASE": { + "REGISTERED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "KNOWLEDGE_BASE" + "smithy.api#enumValue": "REGISTERED" } }, - "EXTERNAL_SOURCES": { + "INCOMPATIBLE_ENDPOINT": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "EXTERNAL_SOURCES" + "smithy.api#enumValue": "INCOMPATIBLE_ENDPOINT" } } } }, - "com.amazonaws.bedrock#RetrieveConfig": { + "com.amazonaws.bedrock#StatusDetails": { "type": "structure", "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.bedrock#KnowledgeBaseId", + "validationDetails": { + "target": "com.amazonaws.bedrock#ValidationDetails", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base.

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

The status details for the validation sub-task of the job.

" } }, - "knowledgeBaseRetrievalConfiguration": { - "target": "com.amazonaws.bedrock#KnowledgeBaseRetrievalConfiguration", + "dataProcessingDetails": { + "target": "com.amazonaws.bedrock#DataProcessingDetails", "traits": { - "smithy.api#documentation": "

Contains configuration details for knowledge base retrieval.

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

The status details for the data processing sub-task of the job.

" + } + }, + "trainingDetails": { + "target": "com.amazonaws.bedrock#TrainingDetails", + "traits": { + "smithy.api#documentation": "

The status details for the training sub-task of the job.

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

The configuration details for retrieving information from a knowledge base.

" + "smithy.api#documentation": "

For a Distillation job, the status details for sub-tasks of the job. Possible statuses for each sub-task include the following:

  • NotStarted

  • InProgress

  • Completed

  • Stopping

  • Stopped

  • Failed

" } }, - "com.amazonaws.bedrock#RoleArn": { - "type": "string", - "traits": { - "smithy.api#documentation": "ARN of a IAM role", - "smithy.api#length": { - "max": 2048 + "com.amazonaws.bedrock#StopEvaluationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StopEvaluationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StopEvaluationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" - } - }, - "com.amazonaws.bedrock#RoutingCriteria": { - "type": "structure", - "members": { - "responseQualityDifference": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The criteria's response quality difference.

", - "smithy.api#range": { - "min": 0, - "max": 100 - }, - "smithy.api#required": {} - } + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" } - }, + ], "traits": { - "smithy.api#documentation": "

Routing criteria for a prompt router.

" + "smithy.api#documentation": "

Stops an evaluation job that is current being created or running.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/evaluation-job/{jobIdentifier}/stop" + } } }, - "com.amazonaws.bedrock#S3Config": { + "com.amazonaws.bedrock#StopEvaluationJobRequest": { "type": "structure", "members": { - "bucketName": { - "target": "com.amazonaws.bedrock#BucketName", + "jobIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", "traits": { - "smithy.api#documentation": "

S3 bucket name.

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

The Amazon Resource Name (ARN) of the evaluation job you want to stop.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "keyPrefix": { - "target": "com.amazonaws.bedrock#KeyPrefix", - "traits": { - "smithy.api#documentation": "

S3 prefix.

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

S3 configuration for storing log data.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#S3DataSource": { + "com.amazonaws.bedrock#StopEvaluationJobResponse": { "type": "structure", - "members": { - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", - "traits": { - "smithy.api#documentation": "

The URI of the Amazon S3 data source.

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

The Amazon S3 data source of the model to import.

" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#S3InputFormat": { - "type": "enum", - "members": { - "JSONL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSONL" - } + "com.amazonaws.bedrock#StopModelCustomizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StopModelCustomizationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StopModelCustomizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" } + ], + "traits": { + "smithy.api#documentation": "

Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/model-customization-jobs/{jobIdentifier}/stop" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#S3ObjectDoc": { + "com.amazonaws.bedrock#StopModelCustomizationJobRequest": { "type": "structure", "members": { - "uri": { - "target": "com.amazonaws.bedrock#kBS3Uri", + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobIdentifier", "traits": { - "smithy.api#documentation": "

The S3 URI location for the wrapper object of the document.

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

Job identifier of the job to stop.

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

The unique wrapper object of the document from the S3 location.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#S3Uri": { - "type": "string", + "com.amazonaws.bedrock#StopModelCustomizationJobResponse": { + "type": "structure", + "members": {}, "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?$" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#SageMakerEndpoint": { - "type": "structure", - "members": { - "initialInstanceCount": { - "target": "com.amazonaws.bedrock#InstanceCount", - "traits": { - "smithy.api#documentation": "

The number of Amazon EC2 compute instances to deploy for initial endpoint creation.

", - "smithy.api#required": {} - } + "com.amazonaws.bedrock#StopModelInvocationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StopModelInvocationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StopModelInvocationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "instanceType": { - "target": "com.amazonaws.bedrock#InstanceType", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 compute instance type to deploy for hosting the model.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.bedrock#ConflictException" }, - "executionRole": { - "target": "com.amazonaws.bedrock#RoleArn", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on Amazon EC2 compute instances or for batch transform jobs.

", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.bedrock#InternalServerException" }, - "kmsEncryptionKey": { - "target": "com.amazonaws.bedrock#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the Amazon EC2 compute instance that hosts the endpoint.

" - } + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, - "vpc": { - "target": "com.amazonaws.bedrock#VpcConfig", - "traits": { - "smithy.api#documentation": "

The VPC configuration for the endpoint.

" - } + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" } - }, - "traits": { - "smithy.api#documentation": "

Specifies the configuration for a Amazon SageMaker endpoint.

" - } - }, - "com.amazonaws.bedrock#SageMakerFlowDefinitionArn": { - "type": "string", + ], "traits": { - "smithy.api#length": { - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:flow-definition/.*$" + "smithy.api#documentation": "

Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/model-invocation-job/{jobIdentifier}/stop" + } } }, - "com.amazonaws.bedrock#SearchType": { - "type": "enum", + "com.amazonaws.bedrock#StopModelInvocationJobRequest": { + "type": "structure", "members": { - "HYBRID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HYBRID" - } - }, - "SEMANTIC": { - "target": "smithy.api#Unit", + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelInvocationJobIdentifier", "traits": { - "smithy.api#enumValue": "SEMANTIC" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job to stop.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#SecurityGroupId": { + "com.amazonaws.bedrock#StopModelInvocationJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#SubnetId": { "type": "string", "traits": { "smithy.api#length": { @@ -14574,152 +19726,117 @@ "smithy.api#pattern": "^[-0-9a-zA-Z]+$" } }, - "com.amazonaws.bedrock#SecurityGroupIds": { + "com.amazonaws.bedrock#SubnetIds": { "type": "list", "member": { - "target": "com.amazonaws.bedrock#SecurityGroupId" + "target": "com.amazonaws.bedrock#SubnetId" }, "traits": { "smithy.api#length": { "min": 1, - "max": 5 + "max": 16 } } }, - "com.amazonaws.bedrock#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" + "com.amazonaws.bedrock#SubscriptionResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateFoundationModelAgreement" + }, + { + "target": "com.amazonaws.bedrock#DeleteFoundationModelAgreement" + }, + { + "target": "com.amazonaws.bedrock#GetFoundationModelAvailability" + }, + { + "target": "com.amazonaws.bedrock#ListFoundationModelAgreementOffers" } - }, - "traits": { - "smithy.api#documentation": "

The number of requests exceeds the service quota. Resubmit your request later.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } + ] }, - "com.amazonaws.bedrock#ServiceUnavailableException": { + "com.amazonaws.bedrock#SupportTerm": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "

Returned if the service cannot complete the request.

", - "smithy.api#error": "server", - "smithy.api#httpError": 503 - } - }, - "com.amazonaws.bedrock#SortByProvisionedModels": { - "type": "enum", - "members": { - "CREATION_TIME": { - "target": "smithy.api#Unit", + "refundPolicyDescription": { + "target": "smithy.api#String", "traits": { - "smithy.api#enumValue": "CreationTime" + "smithy.api#documentation": "

Describes the refund policy.

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

Describes a support term.

" } }, - "com.amazonaws.bedrock#SortJobsBy": { - "type": "enum", + "com.amazonaws.bedrock#Tag": { + "type": "structure", "members": { - "CREATION_TIME": { - "target": "smithy.api#Unit", + "key": { + "target": "com.amazonaws.bedrock#TagKey", "traits": { - "smithy.api#enumValue": "CreationTime" + "smithy.api#documentation": "

Key for the tag.

", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.bedrock#SortModelsBy": { - "type": "enum", - "members": { - "CREATION_TIME": { - "target": "smithy.api#Unit", + }, + "value": { + "target": "com.amazonaws.bedrock#TagValue", "traits": { - "smithy.api#enumValue": "CreationTime" + "smithy.api#documentation": "

Value for the tag.

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

Definition of the key/value pair for a tag.

" } }, - "com.amazonaws.bedrock#SortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ascending" - } + "com.amazonaws.bedrock#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Descending" - } - } + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" } }, - "com.amazonaws.bedrock#Status": { - "type": "enum", - "members": { - "REGISTERED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REGISTERED" - } - }, - "INCOMPATIBLE_ENDPOINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INCOMPATIBLE_ENDPOINT" - } + "com.amazonaws.bedrock#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 } } }, - "com.amazonaws.bedrock#StatusDetails": { - "type": "structure", - "members": { - "validationDetails": { - "target": "com.amazonaws.bedrock#ValidationDetails", - "traits": { - "smithy.api#documentation": "

The status details for the validation sub-task of the job.

" - } - }, - "dataProcessingDetails": { - "target": "com.amazonaws.bedrock#DataProcessingDetails", - "traits": { - "smithy.api#documentation": "

The status details for the data processing sub-task of the job.

" - } - }, - "trainingDetails": { - "target": "com.amazonaws.bedrock#TrainingDetails", - "traits": { - "smithy.api#documentation": "

The status details for the training sub-task of the job.

" - } - } + "com.amazonaws.bedrock#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#Tag" }, "traits": { - "smithy.api#documentation": "

For a Distillation job, the status details for sub-tasks of the job. Possible statuses for each sub-task include the following:

  • NotStarted

  • InProgress

  • Completed

  • Stopping

  • Stopped

  • Failed

" + "smithy.api#length": { + "min": 0, + "max": 200 + } } }, - "com.amazonaws.bedrock#StopEvaluationJob": { + "com.amazonaws.bedrock#TagResource": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#StopEvaluationJobRequest" + "target": "com.amazonaws.bedrock#TagResourceRequest" }, "output": { - "target": "com.amazonaws.bedrock#StopEvaluationJobResponse" + "target": "com.amazonaws.bedrock#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, { "target": "com.amazonaws.bedrock#InternalServerException" }, @@ -14729,27 +19846,36 @@ { "target": "com.amazonaws.bedrock#ThrottlingException" }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, { "target": "com.amazonaws.bedrock#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Stops an evaluation job that is current being created or running.

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

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

", "smithy.api#http": { "code": 200, "method": "POST", - "uri": "/evaluation-job/{jobIdentifier}/stop" + "uri": "/tagResource" } } }, - "com.amazonaws.bedrock#StopEvaluationJobRequest": { + "com.amazonaws.bedrock#TagResourceRequest": { "type": "structure", "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + "resourceARN": { + "target": "com.amazonaws.bedrock#TaggableResourcesArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the evaluation job you want to stop.

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

The Amazon Resource Name (ARN) of the resource to tag.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the resource.

", "smithy.api#required": {} } } @@ -14758,249 +19884,290 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#StopEvaluationJobResponse": { + "com.amazonaws.bedrock#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#StopModelCustomizationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#StopModelCustomizationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#StopModelCustomizationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" + "com.amazonaws.bedrock#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 }, - { - "target": "com.amazonaws.bedrock#InternalServerException" + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrock#TaggableResourcesArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 }, + "smithy.api#pattern": "(^[a-zA-Z0-9][a-zA-Z0-9\\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported)/[a-z0-9]{12}$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:guardrail/[a-z0-9]+$)|(:automated-reasoning-policy/[a-zA-Z0-9]+(:[a-zA-Z0-9]+)?$)|(:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)|(:(provisioned-model|model-invocation-job|model-evaluation-job|evaluation-job|model-import-job|imported-model|async-invoke|provisioned-model-v2|provisioned-model-reservation|prompt-router|custom-model-deployment)/[a-z0-9]{12}$)))" + } + }, + "com.amazonaws.bedrock#TaggingResource": { + "type": "resource", + "operations": [ { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" + "target": "com.amazonaws.bedrock#ListTagsForResource" }, { - "target": "com.amazonaws.bedrock#ThrottlingException" + "target": "com.amazonaws.bedrock#TagResource" }, { - "target": "com.amazonaws.bedrock#ValidationException" + "target": "com.amazonaws.bedrock#UntagResource" } - ], - "traits": { - "smithy.api#documentation": "

Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/model-customization-jobs/{jobIdentifier}/stop" - }, - "smithy.api#idempotent": {} - } + ] }, - "com.amazonaws.bedrock#StopModelCustomizationJobRequest": { + "com.amazonaws.bedrock#TeacherModelConfig": { "type": "structure", "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobIdentifier", + "teacherModelIdentifier": { + "target": "com.amazonaws.bedrock#TeacherModelIdentifier", "traits": { - "smithy.api#documentation": "

Job identifier of the job to stop.

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

The identifier of the teacher model.

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

The maximum number of tokens requested when the customization job invokes the teacher model.

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

Details about a teacher model used for model customization.

" } }, - "com.amazonaws.bedrock#StopModelCustomizationJobResponse": { - "type": "structure", - "members": {}, + "com.amazonaws.bedrock#TeacherModelIdentifier": { + "type": "string", "traits": { - "smithy.api#output": {} + "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})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$)|([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})([:][a-z0-9-]{1,63}){0,2})$" } }, - "com.amazonaws.bedrock#StopModelInvocationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#StopModelInvocationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#StopModelInvocationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" + "com.amazonaws.bedrock#Temperature": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.bedrock#TermDetails": { + "type": "structure", + "members": { + "usageBasedPricingTerm": { + "target": "com.amazonaws.bedrock#PricingTerm", + "traits": { + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" + "legalTerm": { + "target": "com.amazonaws.bedrock#LegalTerm", + "traits": { + "smithy.api#documentation": "

Describes the legal terms.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" + "supportTerm": { + "target": "com.amazonaws.bedrock#SupportTerm", + "traits": { + "smithy.api#documentation": "

Describes the support terms.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrock#ValidationException" + "validityTerm": { + "target": "com.amazonaws.bedrock#ValidityTerm", + "traits": { + "smithy.api#documentation": "

Describes the validity terms.

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

Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/model-invocation-job/{jobIdentifier}/stop" - } + "smithy.api#documentation": "

Describes the usage terms of an offer.

" } }, - "com.amazonaws.bedrock#StopModelInvocationJobRequest": { + "com.amazonaws.bedrock#TextInferenceConfig": { "type": "structure", "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#ModelInvocationJobIdentifier", + "temperature": { + "target": "com.amazonaws.bedrock#Temperature", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job to stop.

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

Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.

" + } + }, + "topP": { + "target": "com.amazonaws.bedrock#TopP", + "traits": { + "smithy.api#documentation": "

A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.

" + } + }, + "maxTokens": { + "target": "com.amazonaws.bedrock#MaxTokens", + "traits": { + "smithy.api#documentation": "

The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitrary values, for actual values consult the limits defined by your specific model.

" + } + }, + "stopSequences": { + "target": "com.amazonaws.bedrock#RAGStopSequences", + "traits": { + "smithy.api#documentation": "

A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitrary values, for actual values consult the limits defined by your specific model.

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

The configuration details for text generation using a language model via the RetrieveAndGenerate function.

" } }, - "com.amazonaws.bedrock#StopModelInvocationJobResponse": { + "com.amazonaws.bedrock#TextPromptTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#ThrottlingException": { "type": "structure", - "members": {}, + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, "traits": { - "smithy.api#output": {} + "smithy.api#documentation": "

The number of requests exceeds the limit. Resubmit your request later.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 } }, - "com.amazonaws.bedrock#SubnetId": { - "type": "string", + "com.amazonaws.bedrock#Timestamp": { + "type": "timestamp", "traits": { - "smithy.api#length": { - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + "smithy.api#timestampFormat": "date-time" } }, - "com.amazonaws.bedrock#SubnetIds": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#SubnetId" + "com.amazonaws.bedrock#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + }, + "resourceName": { + "target": "com.amazonaws.bedrock#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "

The name of the resource with too many tags.

" + } + } }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } + "smithy.api#documentation": "

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 } }, - "com.amazonaws.bedrock#SubscriptionResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateFoundationModelAgreement" - }, - { - "target": "com.amazonaws.bedrock#DeleteFoundationModelAgreement" - }, - { - "target": "com.amazonaws.bedrock#GetFoundationModelAvailability" - }, - { - "target": "com.amazonaws.bedrock#ListFoundationModelAgreementOffers" + "com.amazonaws.bedrock#TopP": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 } - ] + } }, - "com.amazonaws.bedrock#SupportTerm": { + "com.amazonaws.bedrock#TrainingDataConfig": { "type": "structure", "members": { - "refundPolicyDescription": { - "target": "smithy.api#String", + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", "traits": { - "smithy.api#documentation": "

Describes the refund policy.

" + "smithy.api#documentation": "

The S3 URI where the training data is stored.

" + } + }, + "invocationLogsConfig": { + "target": "com.amazonaws.bedrock#InvocationLogsConfig", + "traits": { + "smithy.api#documentation": "

Settings for using invocation logs to customize a model.

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

Describes a support term.

" + "smithy.api#documentation": "

S3 Location of the training data.

" } }, - "com.amazonaws.bedrock#Tag": { + "com.amazonaws.bedrock#TrainingDetails": { "type": "structure", "members": { - "key": { - "target": "com.amazonaws.bedrock#TagKey", + "status": { + "target": "com.amazonaws.bedrock#JobStatusDetails", "traits": { - "smithy.api#documentation": "

Key for the tag.

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

The status of the training sub-task of the job.

" } }, - "value": { - "target": "com.amazonaws.bedrock#TagValue", + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

Value for the tag.

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

The start time of the training sub-task of the job.

" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The latest update to the training sub-task of the job.

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

Definition of the key/value pair for a tag.

" - } - }, - "com.amazonaws.bedrock#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + "smithy.api#documentation": "

For a Distillation job, the status details for the training sub-task of the job.

" } }, - "com.amazonaws.bedrock#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#TagKey" + "com.amazonaws.bedrock#TrainingMetrics": { + "type": "structure", + "members": { + "trainingLoss": { + "target": "com.amazonaws.bedrock#MetricFloat", + "traits": { + "smithy.api#documentation": "

Loss metric associated with the custom job.

" + } + } }, "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } + "smithy.api#documentation": "

Metrics associated with the custom job.

" } }, - "com.amazonaws.bedrock#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#Tag" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 + "com.amazonaws.bedrock#TrainingResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateModelCustomizationJob" + }, + { + "target": "com.amazonaws.bedrock#GetModelCustomizationJob" + }, + { + "target": "com.amazonaws.bedrock#ListModelCustomizationJobs" + }, + { + "target": "com.amazonaws.bedrock#StopModelCustomizationJob" } - } + ] }, - "com.amazonaws.bedrock#TagResource": { + "com.amazonaws.bedrock#UntagResource": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#TagResourceRequest" + "target": "com.amazonaws.bedrock#UntagResourceRequest" }, "output": { - "target": "com.amazonaws.bedrock#TagResourceResponse" + "target": "com.amazonaws.bedrock#UntagResourceResponse" }, "errors": [ { @@ -15015,36 +20182,33 @@ { "target": "com.amazonaws.bedrock#ThrottlingException" }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" - }, { "target": "com.amazonaws.bedrock#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

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

Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

", "smithy.api#http": { "code": 200, "method": "POST", - "uri": "/tagResource" + "uri": "/untagResource" } } }, - "com.amazonaws.bedrock#TagResourceRequest": { + "com.amazonaws.bedrock#UntagResourceRequest": { "type": "structure", "members": { "resourceARN": { "target": "com.amazonaws.bedrock#TaggableResourcesArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to tag.

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

The Amazon Resource Name (ARN) of the resource to untag.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.bedrock#TagList", + "tagKeys": { + "target": "com.amazonaws.bedrock#TagKeyList", "traits": { - "smithy.api#documentation": "

Tags to associate with the resource.

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

Tag keys of the tags to remove from the resource.

", "smithy.api#required": {} } } @@ -15053,298 +20217,267 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrock#TagResourceResponse": { + "com.amazonaws.bedrock#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrock#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" - } - }, - "com.amazonaws.bedrock#TaggableResourcesArn": { - "type": "string", + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "min": 20, - "max": 1011 + "smithy.api#documentation": "

Updates an existing Automated Reasoning policy with new rules, variables, or configuration. This creates a new version of the policy while preserving the previous version.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/automated-reasoning-policies/{policyArn}" }, - "smithy.api#pattern": "(^[a-zA-Z0-9][a-zA-Z0-9\\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported)/[a-z0-9]{12}$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:guardrail/[a-z0-9]+$)|(:automated-reasoning-policy/[a-zA-Z0-9]+(:[a-zA-Z0-9]+)?$)|(:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)|(:(provisioned-model|model-invocation-job|model-evaluation-job|evaluation-job|model-import-job|imported-model|async-invoke|provisioned-model-v2|provisioned-model-reservation|prompt-router|custom-model-deployment)/[a-z0-9]{12}$)))" + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#TaggingResource": { - "type": "resource", - "operations": [ + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyAnnotations": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyAnnotationsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyAnnotationsResponse" + }, + "errors": [ { - "target": "com.amazonaws.bedrock#ListTagsForResource" + "target": "com.amazonaws.bedrock#AccessDeniedException" }, { - "target": "com.amazonaws.bedrock#TagResource" + "target": "com.amazonaws.bedrock#ConflictException" }, { - "target": "com.amazonaws.bedrock#UntagResource" - } - ] - }, - "com.amazonaws.bedrock#TeacherModelConfig": { - "type": "structure", - "members": { - "teacherModelIdentifier": { - "target": "com.amazonaws.bedrock#TeacherModelIdentifier", - "traits": { - "smithy.api#documentation": "

The identifier of the teacher model.

", - "smithy.api#required": {} - } + "target": "com.amazonaws.bedrock#InternalServerException" }, - "maxResponseLengthForInference": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of tokens requested when the customization job invokes the teacher model.

" - } + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" } - }, - "traits": { - "smithy.api#documentation": "

Details about a teacher model used for model customization.

" - } - }, - "com.amazonaws.bedrock#TeacherModelIdentifier": { - "type": "string", - "traits": { - "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})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$)|([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})([:][a-z0-9-]{1,63}){0,2})$" - } - }, - "com.amazonaws.bedrock#Temperature": { - "type": "float", + ], "traits": { - "smithy.api#range": { - "min": 0, - "max": 1 + "smithy.api#documentation": "

Updates the annotations for an Automated Reasoning policy build workflow. This allows you to modify extracted rules, variables, and types before finalizing the policy.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/automated-reasoning-policies/{policyArn}/build-workflows/{buildWorkflowId}/annotations" } } }, - "com.amazonaws.bedrock#TermDetails": { + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyAnnotationsRequest": { "type": "structure", "members": { - "usageBasedPricingTerm": { - "target": "com.amazonaws.bedrock#PricingTerm", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy whose annotations you want to update.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "legalTerm": { - "target": "com.amazonaws.bedrock#LegalTerm", + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", "traits": { - "smithy.api#documentation": "

Describes the legal terms.

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

The unique identifier of the build workflow whose annotations you want to update.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "supportTerm": { - "target": "com.amazonaws.bedrock#SupportTerm", + "annotations": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyAnnotationList", "traits": { - "smithy.api#documentation": "

Describes the support terms.

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

The updated annotations containing modified rules, variables, and types for the policy.

", "smithy.api#required": {} } }, - "validityTerm": { - "target": "com.amazonaws.bedrock#ValidityTerm", + "lastUpdatedAnnotationSetHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", "traits": { - "smithy.api#documentation": "

Describes the validity terms.

" + "smithy.api#documentation": "

The hash value of the annotation set that you're updating. This is used for optimistic concurrency control to prevent conflicting updates.

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

Describes the usage terms of an offer.

" + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] } }, - "com.amazonaws.bedrock#TextInferenceConfig": { + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyAnnotationsResponse": { "type": "structure", "members": { - "temperature": { - "target": "com.amazonaws.bedrock#Temperature", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy.

", + "smithy.api#required": {} } }, - "topP": { - "target": "com.amazonaws.bedrock#TopP", + "buildWorkflowId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyBuildWorkflowId", "traits": { - "smithy.api#documentation": "

A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.

" + "smithy.api#documentation": "

The unique identifier of the build workflow.

", + "smithy.api#required": {} } }, - "maxTokens": { - "target": "com.amazonaws.bedrock#MaxTokens", + "annotationSetHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", "traits": { - "smithy.api#documentation": "

The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitrary values, for actual values consult the limits defined by your specific model.

" + "smithy.api#documentation": "

The new hash value representing the updated state of the annotations.

", + "smithy.api#required": {} } }, - "stopSequences": { - "target": "com.amazonaws.bedrock#RAGStopSequences", + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitrary values, for actual values consult the limits defined by your specific model.

" + "smithy.api#documentation": "

The timestamp when the annotations were updated.

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

The configuration details for text generation using a language model via the RetrieveAndGenerate function.

" - } - }, - "com.amazonaws.bedrock#TextPromptTemplate": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100000 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "

The number of requests exceeds the limit. Resubmit your request later.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.bedrock#Timestamp": { - "type": "timestamp", - "traits": { - "smithy.api#timestampFormat": "date-time" + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.bedrock#AutomatedReasoningPolicyResource" + } + ] } }, - "com.amazonaws.bedrock#TooManyTagsException": { + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyRequest": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Automated Reasoning policy to update. This must be the ARN of a draft policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, - "resourceName": { - "target": "com.amazonaws.bedrock#TaggableResourcesArn", + "policyDefinition": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDefinition", "traits": { - "smithy.api#documentation": "

The name of the resource with too many tags.

" + "smithy.api#documentation": "

The updated policy definition containing the formal logic rules, variables, and types.

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

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.bedrock#TopP": { - "type": "float", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.bedrock#TrainingDataConfig": { - "type": "structure", - "members": { - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", + }, + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", "traits": { - "smithy.api#documentation": "

The S3 URI where the training data is stored.

" + "smithy.api#documentation": "

The updated name for the Automated Reasoning policy.

" } }, - "invocationLogsConfig": { - "target": "com.amazonaws.bedrock#InvocationLogsConfig", + "description": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyDescription", "traits": { - "smithy.api#documentation": "

Settings for using invocation logs to customize a model.

" + "smithy.api#documentation": "

The updated description for the Automated Reasoning policy.

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

S3 Location of the training data.

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrock#TrainingDetails": { + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyResponse": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.bedrock#JobStatusDetails", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

The status of the training sub-task of the job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated policy.

", + "smithy.api#required": {} } }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "name": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyName", "traits": { - "smithy.api#documentation": "

The start time of the training sub-task of the job.

" + "smithy.api#documentation": "

The updated name of the policy.

", + "smithy.api#required": {} } }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", + "definitionHash": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyHash", "traits": { - "smithy.api#documentation": "

The latest update to the training sub-task of the job.

" + "smithy.api#documentation": "

The hash of the updated policy definition.

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

For a Distillation job, the status details for the training sub-task of the job.

" - } - }, - "com.amazonaws.bedrock#TrainingMetrics": { - "type": "structure", - "members": { - "trainingLoss": { - "target": "com.amazonaws.bedrock#MetricFloat", + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", "traits": { - "smithy.api#documentation": "

Loss metric associated with the custom job.

" + "smithy.api#documentation": "

The timestamp when the policy was last updated.

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

Metrics associated with the custom job.

" + "smithy.api#output": {} } }, - "com.amazonaws.bedrock#TrainingResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateModelCustomizationJob" - }, - { - "target": "com.amazonaws.bedrock#GetModelCustomizationJob" - }, - { - "target": "com.amazonaws.bedrock#ListModelCustomizationJobs" - }, - { - "target": "com.amazonaws.bedrock#StopModelCustomizationJob" - } - ] - }, - "com.amazonaws.bedrock#UntagResource": { + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyTestCase": { "type": "operation", "input": { - "target": "com.amazonaws.bedrock#UntagResourceRequest" + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyTestCaseRequest" }, "output": { - "target": "com.amazonaws.bedrock#UntagResourceResponse" + "target": "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyTestCaseResponse" }, "errors": [ { "target": "com.amazonaws.bedrock#AccessDeniedException" }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, { "target": "com.amazonaws.bedrock#InternalServerException" }, + { + "target": "com.amazonaws.bedrock#ResourceInUseException" + }, { "target": "com.amazonaws.bedrock#ResourceNotFoundException" }, @@ -15356,39 +20489,103 @@ } ], "traits": { - "smithy.api#documentation": "

Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

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

Updates an existing Automated Reasoning policy test. You can modify the content, query, expected result, and confidence threshold.

", "smithy.api#http": { "code": 200, - "method": "POST", - "uri": "/untagResource" - } + "method": "PATCH", + "uri": "/automated-reasoning-policies/{policyArn}/test-cases/{testCaseId}" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.bedrock#UntagResourceRequest": { + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyTestCaseRequest": { "type": "structure", "members": { - "resourceARN": { - "target": "com.amazonaws.bedrock#TaggableResourcesArn", + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to untag.

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

The Amazon Resource Name (ARN) of the Automated Reasoning policy that contains the test.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "tagKeys": { - "target": "com.amazonaws.bedrock#TagKeyList", + "testCaseId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId", "traits": { - "smithy.api#documentation": "

Tag keys of the tags to remove from the resource.

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

The unique identifier of the test to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "guardContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestGuardContent", + "traits": { + "smithy.api#documentation": "

The updated content to be validated by the Automated Reasoning policy.

", + "smithy.api#required": {} + } + }, + "queryContent": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestQueryContent", + "traits": { + "smithy.api#documentation": "

The updated input query or prompt that generated the content.

" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the test was last updated. This is used as a concurrency token to prevent conflicting modifications.

", + "smithy.api#required": {} + } + }, + "expectedAggregatedFindingsResult": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckResult", + "traits": { + "smithy.api#documentation": "

The updated expected result of the Automated Reasoning check.

", "smithy.api#required": {} } + }, + "confidenceThreshold": { + "target": "com.amazonaws.bedrock#AutomatedReasoningCheckTranslationConfidence", + "traits": { + "smithy.api#documentation": "

The updated minimum confidence level for logic validation. If null is provided, the threshold will be removed.

" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key ARN for encrypting the test at rest. If not provided, the key will not be updated. Use DISCARD to remove the key.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.

", + "smithy.api#idempotencyToken": {} + } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.bedrock#UntagResourceResponse": { + "com.amazonaws.bedrock#UpdateAutomatedReasoningPolicyTestCaseResponse": { "type": "structure", - "members": {}, + "members": { + "policyArn": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy that contains the updated test.

", + "smithy.api#required": {} + } + }, + "testCaseId": { + "target": "com.amazonaws.bedrock#AutomatedReasoningPolicyTestCaseId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the updated test.

", + "smithy.api#required": {} + } + } + }, "traits": { "smithy.api#output": {} } @@ -15488,6 +20685,12 @@ "smithy.api#documentation": "

The contextual grounding policy configuration used to update a guardrail.

" } }, + "automatedReasoningPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailAutomatedReasoningPolicyConfig", + "traits": { + "smithy.api#documentation": "

Updated configuration for Automated Reasoning policies associated with the guardrail.

" + } + }, "crossRegionConfig": { "target": "com.amazonaws.bedrock#GuardrailCrossRegionConfig", "traits": { diff --git a/codegen/sdk/aws-models/budgets.json b/codegen/sdk/aws-models/budgets.json index 4cae0ca6dc4..a2d37a9abd0 100644 --- a/codegen/sdk/aws-models/budgets.json +++ b/codegen/sdk/aws-models/budgets.json @@ -129,12 +129,6 @@ "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, @@ -154,6 +148,12 @@ "required": false, "documentation": "Override the endpoint used to send this request", "type": "String" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" } }, "rules": [ @@ -185,596 +185,567 @@ "type": "error" }, { - "conditions": [ + "conditions": [], + "rules": [ { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseDualStack" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" }, - true - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ], - "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": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], + "conditions": [], "rules": [ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { "ref": "Region" } - ], - "assign": "PartitionResult" + ] } ], "rules": [ { "conditions": [ { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" - ] - }, - { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] + "ref": "Region" + } + ], + "assign": "PartitionResult" } ], - "endpoint": { - "url": "https://budgets.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ + "rules": [ { - "fn": "stringEquals", - "argv": [ + "conditions": [ { - "fn": "getAttr", + "fn": "stringEquals", "argv": [ { - "ref": "PartitionResult" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] }, - "name" + "aws" ] }, - "aws-cn" - ] - }, - { - "fn": "booleanEquals", - "argv": [ { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://budgets.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "cn-northwest-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "name" + false ] }, - "aws-iso" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] - } - ], - "endpoint": { - "url": "https://budgets.c2s.ic.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-iso-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "name" + true + ] + } + ], + "endpoint": { + "url": "https://budgets.us-east-1.api.aws", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } ] }, - "aws-iso-b" - ] + "headers": {} + }, + "type": "endpoint" }, { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseFIPS" + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-b" + ] }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ { - "ref": "UseDualStack" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] }, - false - ] - } - ], - "endpoint": { - "url": "https://budgets.global.sc2s.sgov.gov", - "properties": { - "authSchemes": [ { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-isob-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "name" + false + ] + } + ], + "endpoint": { + "url": "https://budgets.global.sc2s.sgov.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isob-east-1" + } ] }, - "aws-iso-e" - ] + "headers": {} + }, + "type": "endpoint" }, { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseFIPS" + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-e" + ] }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ { - "ref": "UseDualStack" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] }, - 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", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "name" + false + ] + } + ], + "endpoint": { + "url": "https://budgets.global.cloud.adc-e.uk", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eu-isoe-west-1" + } ] }, - "aws-iso-f" - ] + "headers": {} + }, + "type": "endpoint" }, { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseFIPS" + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-f" + ] }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ { - "ref": "UseDualStack" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] }, - false - ] - } - ], - "endpoint": { - "url": "https://budgets.global.csp.hci.ic.gov", - "properties": { - "authSchemes": [ { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-isof-south-1" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + ], + "endpoint": { + "url": "https://budgets.global.csp.hci.ic.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] }, - true - ] + "headers": {} + }, + "type": "endpoint" }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } + "ref": "UseFIPS" + }, + true ] }, { "fn": "booleanEquals", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } + "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://budgets-fips.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, { "conditions": [], - "endpoint": { - "url": "https://budgets-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ], "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" - ] + "ref": "UseFIPS" }, true ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] } ], "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://budgets-fips.{PartitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, { "conditions": [], - "endpoint": { - "url": "https://budgets-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ], "type": "tree" }, { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseDualStack" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] }, - true - ] - } - ], - "rules": [ - { - "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { - "fn": "getAttr", + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ + true, { - "ref": "PartitionResult" - }, - "supportsDualStack" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } ] } - ] - } - ], - "rules": [ + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://budgets.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, { "conditions": [], - "endpoint": { - "url": "https://budgets.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ], "type": "tree" }, { "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "endpoint": { + "url": "https://budgets.{PartitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" } ], "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://budgets.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" } ], "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ], "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { - "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://budgets.amazonaws.com" + "url": "https://example.com" } }, "params": { - "Region": "aws-global", + "Endpoint": "https://example.com", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips enabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": true + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://budgets-fips.us-east-1.api.aws" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://budgets-fips.api.aws" } }, "params": { @@ -787,7 +758,15 @@ "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://budgets-fips.us-east-1.amazonaws.com" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://budgets-fips.amazonaws.com" } }, "params": { @@ -800,6 +779,14 @@ "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } + ] + }, "url": "https://budgets.us-east-1.api.aws" } }, @@ -817,7 +804,6 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "budgets", "signingRegion": "us-east-1" } ] @@ -832,75 +818,76 @@ } }, { - "documentation": "For region aws-cn-global with FIPS disabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "budgets", "signingRegion": "cn-northwest-1" } ] }, - "url": "https://budgets.amazonaws.com.cn" - } - }, - "params": { - "Region": "aws-cn-global", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://budgets-fips.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://budgets-fips.api.amazonwebservices.com.cn" } }, "params": { - "Region": "cn-north-1", + "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://budgets-fips.cn-north-1.amazonaws.com.cn" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://budgets-fips.amazonaws.com.cn" } }, "params": { - "Region": "cn-north-1", + "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://budgets.cn-north-1.api.amazonwebservices.com.cn" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://budgets.api.amazonwebservices.com.cn" } }, "params": { - "Region": "cn-north-1", + "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "budgets", "signingRegion": "cn-northwest-1" } ] @@ -909,81 +896,91 @@ } }, "params": { - "Region": "cn-north-1", + "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://budgets-fips.us-gov-east-1.api.aws" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://budgets-fips.api.aws" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://budgets-fips.us-gov-east-1.amazonaws.com" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://budgets-fips.amazonaws.com" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://budgets.us-gov-east-1.api.aws" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://budgets.api.aws" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://budgets.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region aws-iso-global with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-iso-east-1" + "signingRegion": "us-gov-west-1" } ] }, - "url": "https://budgets.c2s.ic.gov" + "url": "https://budgets.amazonaws.com" } }, "params": { - "Region": "aws-iso-global", + "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } @@ -1003,7 +1000,15 @@ "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://budgets-fips.us-iso-east-1.c2s.ic.gov" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-iso-east-1" + } + ] + }, + "url": "https://budgets-fips.c2s.ic.gov" } }, "params": { @@ -1031,7 +1036,6 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "budgets", "signingRegion": "us-iso-east-1" } ] @@ -1045,28 +1049,6 @@ "UseDualStack": false } }, - { - "documentation": "For region aws-iso-b-global with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://budgets.global.sc2s.sgov.gov" - } - }, - "params": { - "Region": "aws-iso-b-global", - "UseFIPS": false, - "UseDualStack": false - } - }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", "expect": { @@ -1082,7 +1064,15 @@ "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://budgets-fips.us-isob-east-1.sc2s.sgov.gov" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isob-east-1" + } + ] + }, + "url": "https://budgets-fips.sc2s.sgov.gov" } }, "params": { @@ -1110,7 +1100,6 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "budgets", "signingRegion": "us-isob-east-1" } ] @@ -1125,98 +1114,131 @@ } }, { - "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-isoe-west-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": "eu-isoe-west-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "budgets", "signingRegion": "eu-isoe-west-1" } ] }, - "url": "https://budgets.global.cloud.adc-e.uk" + "url": "https://budgets-fips.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", - "UseFIPS": false, + "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "budgets", - "signingRegion": "us-isof-south-1" + "signingRegion": "eu-isoe-west-1" } ] }, - "url": "https://budgets.global.csp.hci.ic.gov" + "url": "https://budgets.global.cloud.adc-e.uk" } }, "params": { - "Region": "us-isof-south-1", + "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://example.com" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" + "Region": "us-isof-south-1", + "UseFIPS": true, + "UseDualStack": true } }, { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://example.com" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://budgets-fips.csp.hci.ic.gov" } }, "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" + "Region": "us-isof-south-1", + "UseFIPS": true, + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" + "Region": "us-isof-south-1", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://budgets.global.csp.hci.ic.gov" + } }, "params": { - "Region": "us-east-1", + "Region": "us-isof-south-1", "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" + "UseDualStack": false } }, { diff --git a/codegen/sdk/aws-models/cleanrooms.json b/codegen/sdk/aws-models/cleanrooms.json index a1cffa22e99..06c4af86e0c 100644 --- a/codegen/sdk/aws-models/cleanrooms.json +++ b/codegen/sdk/aws-models/cleanrooms.json @@ -2502,7 +2502,7 @@ "analyticsEngine": { "target": "com.amazonaws.cleanrooms#AnalyticsEngine", "traits": { - "smithy.api#documentation": "

The analytics engine for the collaboration.

" + "smithy.api#documentation": "

The analytics engine for the collaboration.

After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

" } } }, @@ -3504,7 +3504,7 @@ "analyticsEngine": { "target": "com.amazonaws.cleanrooms#AnalyticsEngine", "traits": { - "smithy.api#documentation": "

The analytics engine.

" + "smithy.api#documentation": "

The analytics engine.

After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

" } } }, @@ -4964,7 +4964,7 @@ "source": { "target": "com.amazonaws.cleanrooms#AnalysisSource", "traits": { - "smithy.api#documentation": "

The information in the analysis template. Currently supports text, the query text for the analysis template.

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

The information in the analysis template.

", "smithy.api#required": {} } }, @@ -5110,7 +5110,7 @@ "analyticsEngine": { "target": "com.amazonaws.cleanrooms#AnalyticsEngine", "traits": { - "smithy.api#documentation": "

The analytics engine.

" + "smithy.api#documentation": "

The analytics engine.

After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

" } } } @@ -5961,7 +5961,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a new privacy budget template", - "smithy.api#documentation": "

Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the UpdatePrivacyBudgetTemplate operation.

", + "smithy.api#documentation": "

Creates a privacy budget template for a specified collaboration. Each collaboration can have only one privacy budget template. If you need to change the privacy budget template, use the UpdatePrivacyBudgetTemplate operation.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -6839,7 +6839,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to remove a privacy budget from a collaboration", - "smithy.api#documentation": "

Deletes a privacy budget template for a specified membership.

", + "smithy.api#documentation": "

Deletes a privacy budget template for a specified collaboration.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -15506,7 +15506,7 @@ "analyticsEngine": { "target": "com.amazonaws.cleanrooms#AnalyticsEngine", "traits": { - "smithy.api#documentation": "

The analytics engine.

" + "smithy.api#documentation": "

The analytics engine.

After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

" } } } @@ -15632,6 +15632,9 @@ { "target": "com.amazonaws.cleanrooms#ResourceNotFoundException" }, + { + "target": "com.amazonaws.cleanrooms#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.cleanrooms#ThrottlingException" }, @@ -15936,6 +15939,15 @@ "smithy.api#documentation": "

A new description for the configured table.

" } }, + "tableReference": { + "target": "com.amazonaws.cleanrooms#TableReference" + }, + "allowedColumns": { + "target": "com.amazonaws.cleanrooms#AllowedColumnList", + "traits": { + "smithy.api#documentation": "

The columns of the underlying table that can be used by collaborations or analysis rules.

" + } + }, "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { @@ -16261,7 +16273,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to update a privacy budget template", - "smithy.api#documentation": "

Updates the privacy budget template for the specified membership.

", + "smithy.api#documentation": "

Updates the privacy budget template for the specified collaboration.

", "smithy.api#http": { "code": 200, "method": "PATCH", diff --git a/codegen/sdk/aws-models/cleanroomsml.json b/codegen/sdk/aws-models/cleanroomsml.json index 48f138c8bb7..0c2e62ef2b9 100644 --- a/codegen/sdk/aws-models/cleanroomsml.json +++ b/codegen/sdk/aws-models/cleanroomsml.json @@ -9688,6 +9688,13 @@ "traits": { "smithy.api#documentation": "

Provides configuration information for the workers that will perform the protected query.

" } + }, + "resultFormat": { + "target": "com.amazonaws.cleanroomsml#ResultFormat", + "traits": { + "smithy.api#default": "CSV", + "smithy.api#documentation": "

The format in which the query results should be returned. If not specified, defaults to CSV.

" + } } }, "traits": { @@ -9963,6 +9970,26 @@ } } }, + "com.amazonaws.cleanroomsml#ResultFormat": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + } + }, + "traits": { + "smithy.api#documentation": "File format of the returned data.\n" + } + }, "com.amazonaws.cleanroomsml#S3ConfigMap": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/cloudfront.json b/codegen/sdk/aws-models/cloudfront.json index f5ca4f44805..35a37687827 100644 --- a/codegen/sdk/aws-models/cloudfront.json +++ b/codegen/sdk/aws-models/cloudfront.json @@ -399,7 +399,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.

With this operation you can move an alias that's already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.

To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

The AssociateAlias API operation only supports standard distributions. To move domains between distribution tenants and/or standard distributions, we recommend that you use the UpdateDomainAssociation API operation instead.

Associates an alias with a CloudFront standard distribution. An alias is commonly known as a custom domain or vanity domain. It can also be called a CNAME or alternate domain name.

With this operation, you can move an alias that's already used for a standard distribution to a different standard distribution. This prevents the downtime that could occur if you first remove the alias from one standard distribution and then separately add the alias to another standard distribution.

To use this operation, specify the alias and the ID of the target standard distribution.

For more information, including how to set up the target standard distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different standard distribution or distribution tenant in the Amazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/distribution/{TargetDistributionId}/associate-alias", @@ -413,7 +413,7 @@ "TargetDistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The ID of the distribution that you're associating the alias with.

", + "smithy.api#documentation": "

The ID of the standard distribution that you're associating the alias with.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -421,7 +421,7 @@ "Alias": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The alias (also known as a CNAME) to add to the target distribution.

", + "smithy.api#documentation": "

The alias (also known as a CNAME) to add to the target standard distribution.

", "smithy.api#httpQuery": "Alias", "smithy.api#required": {} } @@ -668,7 +668,7 @@ "TrustedSigners": { "target": "com.amazonaws.cloudfront#TrustedSigners", "traits": { - "smithy.api#documentation": "

We recommend using TrustedKeyGroups instead of TrustedSigners.

A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

We recommend using TrustedKeyGroups instead of TrustedSigners.

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

" } }, "TrustedKeyGroups": { @@ -690,7 +690,7 @@ "SmoothStreaming": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" } }, "Compress": { @@ -758,26 +758,26 @@ "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" } }, "DefaultTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" } }, "MaxTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" } } }, "traits": { - "smithy.api#documentation": "

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see Quotas in the Amazon CloudFront Developer Guide.

If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't specify an empty individual CacheBehavior element, because this is invalid. For more information, see CacheBehaviors.

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

For more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see Quotas in the Amazon CloudFront Developer Guide.

If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't specify an empty individual CacheBehavior element, because this is invalid. For more information, see CacheBehaviors.

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the Cache-Control: no-cache, no-store, or private directives are present in the origin headers.

For more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" } }, "com.amazonaws.cloudfront#CacheBehaviorList": { @@ -895,7 +895,7 @@ } }, "traits": { - "smithy.api#documentation": "

A cache policy configuration.

This configuration determines the following:

  • The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

  • The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.

" + "smithy.api#documentation": "

A cache policy configuration.

This configuration determines the following:

  • The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

  • The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

    If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the Cache-Control: no-cache, no-store, or private directives are present in the origin headers.

The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.

" } }, "com.amazonaws.cloudfront#CachePolicyCookieBehavior": { @@ -1860,6 +1860,35 @@ "aws.auth#sigv4": { "name": "cloudfront" }, + "aws.endpoints#standardPartitionalEndpoints": { + "endpointPatternType": "service_dnsSuffix", + "partitionEndpointSpecialCases": { + "aws": [ + { + "endpoint": "https://cloudfront.global.api.aws", + "region": "us-east-1", + "dualStack": true + }, + { + "endpoint": "https://cloudfront-fips.global.api.aws", + "region": "us-east-1", + "dualStack": true, + "fips": true + } + ], + "aws-cn": [ + { + "endpoint": "https://cloudfront.cn-northwest-1.amazonaws.com.cn", + "region": "cn-northwest-1" + }, + { + "endpoint": "https://cloudfront-fips.cn-northwest-1.amazonaws.com.cn", + "region": "cn-northwest-1", + "fips": true + } + ] + } + }, "aws.protocols#restXml": {}, "smithy.api#documentation": "Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.

", "smithy.api#title": "Amazon CloudFront", @@ -1869,12 +1898,6 @@ "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, @@ -1894,6 +1917,12 @@ "required": false, "documentation": "Override the endpoint used to send this request", "type": "String" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" } }, "rules": [ @@ -1925,465 +1954,567 @@ "type": "error" }, { - "conditions": [ + "conditions": [], + "rules": [ { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseDualStack" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" }, - true - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ], - "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": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], + "conditions": [], "rules": [ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { "ref": "Region" } - ], - "assign": "PartitionResult" + ] } ], "rules": [ { "conditions": [ { - "fn": "stringEquals", + "fn": "aws.partition", "argv": [ { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", "argv": [ { - "ref": "PartitionResult" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] }, - "name" + "aws" ] }, - "aws" - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ { - "ref": "UseDualStack" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] }, - false - ] - } - ], - "endpoint": { - "url": "https://cloudfront.amazonaws.com", - "properties": { - "authSchemes": [ { - "name": "sigv4", - "signingName": "cloudfront", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "name" + true + ] + } + ], + "endpoint": { + "url": "https://cloudfront.global.api.aws", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } ] }, - "aws" - ] + "headers": {} + }, + "type": "endpoint" }, { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseFIPS" + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ { - "ref": "UseDualStack" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] }, - false - ] - } - ], - "endpoint": { - "url": "https://cloudfront-fips.amazonaws.com", - "properties": { - "authSchemes": [ { - "name": "sigv4", - "signingName": "cloudfront", - "signingRegion": "us-east-1" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "name" + true + ] + } + ], + "endpoint": { + "url": "https://cloudfront-fips.global.api.aws", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } ] }, - "aws-cn" - ] + "headers": {} + }, + "type": "endpoint" }, { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseFIPS" + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-cn" + ] }, - false - ] - }, - { - "fn": "booleanEquals", - "argv": [ { - "ref": "UseDualStack" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] }, - false - ] - } - ], - "endpoint": { - "url": "https://cloudfront.cn-northwest-1.amazonaws.com.cn", - "properties": { - "authSchemes": [ { - "name": "sigv4", - "signingName": "cloudfront", - "signingRegion": "cn-northwest-1" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + ], + "endpoint": { + "url": "https://cloudfront.cn-northwest-1.amazonaws.com.cn", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] }, - true - ] + "headers": {} + }, + "type": "endpoint" }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] - } + }, + "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } + "ref": "UseFIPS" + }, + true ] - } - ], - "rules": [ + }, { - "conditions": [], - "endpoint": { - "url": "https://cloudfront-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] } ], - "type": "tree" + "endpoint": { + "url": "https://cloudfront-fips.cn-northwest-1.amazonaws.com.cn", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" }, { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseFIPS" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] }, - true - ] - } - ], - "rules": [ - { - "conditions": [ { "fn": "booleanEquals", "argv": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "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://cloudfront-fips.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, { "conditions": [], - "endpoint": { - "url": "https://cloudfront-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ], "type": "tree" }, { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseDualStack" + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] }, - true - ] - } - ], - "rules": [ - { - "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { - "fn": "getAttr", + "ref": "UseDualStack" + }, + false + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] }, - "supportsDualStack" + true ] } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cloudfront-fips.{PartitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "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": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true ] } ], "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cloudfront.{PartitionResult#dualStackDnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, { "conditions": [], - "endpoint": { - "url": "https://cloudfront.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ], "type": "tree" }, { "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "endpoint": { + "url": "https://cloudfront.{PartitionResult#dnsSuffix}", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "{PartitionResult#implicitGlobalRegion}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" } ], "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://cloudfront.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" } ], "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ], "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { - "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "cloudfront", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://cloudfront.amazonaws.com" + "url": "https://example.com" } }, "params": { - "Region": "aws-global", + "Endpoint": "https://example.com", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips enabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": true + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region aws-global with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "cloudfront", "signingRegion": "us-east-1" } ] }, - "url": "https://cloudfront-fips.amazonaws.com" - } - }, - "params": { - "Region": "aws-global", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://cloudfront-fips.us-east-1.api.aws" + "url": "https://cloudfront-fips.global.api.aws" } }, "params": { @@ -2400,7 +2531,6 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "cloudfront", "signingRegion": "us-east-1" } ] @@ -2418,7 +2548,15 @@ "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://cloudfront.us-east-1.api.aws" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://cloudfront.global.api.aws" } }, "params": { @@ -2435,7 +2573,6 @@ "authSchemes": [ { "name": "sigv4", - "signingName": "cloudfront", "signingRegion": "us-east-1" } ] @@ -2450,75 +2587,76 @@ } }, { - "documentation": "For region aws-cn-global with FIPS disabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "cloudfront", "signingRegion": "cn-northwest-1" } ] }, - "url": "https://cloudfront.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "aws-cn-global", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://cloudfront-fips.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://cloudfront-fips.api.amazonwebservices.com.cn" } }, "params": { - "Region": "cn-north-1", + "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cloudfront-fips.cn-north-1.amazonaws.com.cn" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://cloudfront-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { - "Region": "cn-north-1", + "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://cloudfront.cn-north-1.api.amazonwebservices.com.cn" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://cloudfront.api.amazonwebservices.com.cn" } }, "params": { - "Region": "cn-north-1", + "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", - "signingName": "cloudfront", "signingRegion": "cn-northwest-1" } ] @@ -2527,59 +2665,91 @@ } }, "params": { - "Region": "cn-north-1", + "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://cloudfront-fips.us-gov-east-1.api.aws" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://cloudfront-fips.api.aws" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cloudfront-fips.us-gov-east-1.amazonaws.com" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://cloudfront-fips.amazonaws.com" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://cloudfront.us-gov-east-1.api.aws" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://cloudfront.api.aws" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cloudfront.us-gov-east-1.amazonaws.com" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://cloudfront.amazonaws.com" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } @@ -2599,7 +2769,15 @@ "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cloudfront-fips.us-iso-east-1.c2s.ic.gov" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-iso-east-1" + } + ] + }, + "url": "https://cloudfront-fips.c2s.ic.gov" } }, "params": { @@ -2623,7 +2801,15 @@ "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cloudfront.us-iso-east-1.c2s.ic.gov" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-iso-east-1" + } + ] + }, + "url": "https://cloudfront.c2s.ic.gov" } }, "params": { @@ -2647,7 +2833,15 @@ "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cloudfront-fips.us-isob-east-1.sc2s.sgov.gov" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isob-east-1" + } + ] + }, + "url": "https://cloudfront-fips.sc2s.sgov.gov" } }, "params": { @@ -2671,7 +2865,15 @@ "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cloudfront.us-isob-east-1.sc2s.sgov.gov" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isob-east-1" + } + ] + }, + "url": "https://cloudfront.sc2s.sgov.gov" } }, "params": { @@ -2681,54 +2883,131 @@ } }, { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "documentation": "For region eu-isoe-west-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": "eu-isoe-west-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://example.com" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eu-isoe-west-1" + } + ] + }, + "url": "https://cloudfront-fips.cloud.adc-e.uk" } }, "params": { - "Region": "us-east-1", + "Region": "eu-isoe-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "eu-isoe-west-1", "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" + "UseDualStack": true } }, { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://example.com" + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eu-isoe-west-1" + } + ] + }, + "url": "https://cloudfront.cloud.adc-e.uk" } }, "params": { + "Region": "eu-isoe-west-1", "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" + "UseDualStack": false } }, { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-east-1", + "Region": "us-isof-south-1", "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" + "UseDualStack": true } }, { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://cloudfront-fips.csp.hci.ic.gov" + } }, "params": { - "Region": "us-east-1", + "Region": "us-isof-south-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://cloudfront.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" + "UseDualStack": false } }, { @@ -2760,18 +3039,18 @@ "DistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The (partially hidden) ID of the CloudFront distribution associated with the alias.

" + "smithy.api#documentation": "

The (partially hidden) ID of the CloudFront standard distribution associated with the alias.

" } }, "AccountId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The (partially hidden) ID of the Amazon Web Services account that owns the distribution that's associated with the alias.

" + "smithy.api#documentation": "

The (partially hidden) ID of the Amazon Web Services account that owns the standard distribution that's associated with the alias.

" } } }, "traits": { - "smithy.api#documentation": "

An alias (also called a CNAME) and the CloudFront distribution and Amazon Web Services account ID that it's associated with. The distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.

" + "smithy.api#documentation": "

An alias (also called a CNAME) and the CloudFront standard distribution and Amazon Web Services account ID that it's associated with. The standard distribution and account IDs are partially hidden, which allows you to identify the standard distributions and accounts that you own, and helps to protect the information of ones that you don't own.

" } }, "com.amazonaws.cloudfront#ConflictingAliases": { @@ -2812,7 +3091,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of aliases (also called CNAMEs) and the CloudFront distributions and Amazon Web Services accounts that they are associated with. In the list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.

" + "smithy.api#documentation": "

A list of aliases (also called CNAMEs) and the CloudFront standard distributions and Amazon Web Services accounts that they are associated with. In the list, the standard distribution and account IDs are partially hidden, which allows you to identify the standard distributions and accounts that you own, but helps to protect the information of ones that you don't own.

" } }, "com.amazonaws.cloudfront#ConnectionGroup": { @@ -3741,7 +4020,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a cache policy.

After you create a cache policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the cache policy determines the following:

  • The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

  • The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.

For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.

", + "smithy.api#documentation": "

Creates a cache policy.

After you create a cache policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the cache policy determines the following:

  • The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

  • The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

    If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the Cache-Control: no-cache, no-store, or private directives are present in the origin headers.

The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.

For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/cache-policy", @@ -6345,19 +6624,19 @@ "OriginSslProtocols": { "target": "com.amazonaws.cloudfront#OriginSslProtocols", "traits": { - "smithy.api#documentation": "

Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3, TLSv1, TLSv1.1, and TLSv1.2.

For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include SSLv3, TLSv1, TLSv1.1, and TLSv1.2.

For more information, see Minimum Origin SSL Protocol in the Amazon CloudFront Developer Guide.

" } }, "OriginReadTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.

For more information, see Response timeout (custom origins only) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.

For more information, see Response timeout in the Amazon CloudFront Developer Guide.

" } }, "OriginKeepaliveTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds.

For more information, see Keep-alive timeout (custom origins only) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds.

For more information, see Keep-alive timeout (custom origins only) in the Amazon CloudFront Developer Guide.

" } } }, @@ -6421,7 +6700,7 @@ "TrustedSigners": { "target": "com.amazonaws.cloudfront#TrustedSigners", "traits": { - "smithy.api#documentation": "

We recommend using TrustedKeyGroups instead of TrustedSigners.

A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

We recommend using TrustedKeyGroups instead of TrustedSigners.

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

" } }, "TrustedKeyGroups": { @@ -6443,7 +6722,7 @@ "SmoothStreaming": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" } }, "Compress": { @@ -6511,26 +6790,26 @@ "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

This field is deprecated. We recommend that you use the MinTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" } }, "DefaultTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

This field is deprecated. We recommend that you use the DefaultTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" } }, "MaxTTL": { "target": "com.amazonaws.cloudfront#long", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

This field is deprecated. We recommend that you use the MaxTTL field in a cache policy instead of this field. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" } } }, "traits": { - "smithy.api#documentation": "

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if request URLs don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + "smithy.api#documentation": "

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if request URLs don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the Cache-Control: no-cache, no-store, or private directives are present in the origin headers.

" } }, "com.amazonaws.cloudfront#DeleteAnycastIpList": { @@ -7110,7 +7389,7 @@ "type": "structure", "members": { "Name": { - "target": "com.amazonaws.cloudfront#string", + "target": "com.amazonaws.cloudfront#FunctionName", "traits": { "smithy.api#documentation": "

The name of the function that you are deleting.

", "smithy.api#httpLabel": {}, @@ -7805,7 +8084,7 @@ "type": "structure", "members": { "Name": { - "target": "com.amazonaws.cloudfront#string", + "target": "com.amazonaws.cloudfront#FunctionName", "traits": { "smithy.api#documentation": "

The name of the function that you are getting information about.

", "smithy.api#httpLabel": {}, @@ -8192,7 +8471,7 @@ "Aliases": { "target": "com.amazonaws.cloudfront#Aliases", "traits": { - "smithy.api#documentation": "

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" } }, "DefaultRootObject": { @@ -8249,7 +8528,7 @@ "PriceClass": { "target": "com.amazonaws.cloudfront#PriceClass", "traits": { - "smithy.api#documentation": "

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing.

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing.

" } }, "Enabled": { @@ -8274,7 +8553,7 @@ "WebACLId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. To specify a web ACL created using WAF Classic, use the ACL ID, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide.

" + "smithy.api#documentation": "

Multi-tenant distributions only support WAF V2 web ACLs.

A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. To specify a web ACL created using WAF Classic, use the ACL ID, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the WAF Developer Guide.

" } }, "HttpVersion": { @@ -8286,37 +8565,37 @@ "IsIPV6Enabled": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide.

If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

" + "smithy.api#documentation": "

To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup.

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

If you're using an Route 53 Amazon Web Services Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Route 53 Amazon Web Services Integration Developer Guide.

If you created a CNAME resource record set, either with Route 53 Amazon Web Services Integration or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

" } }, "ContinuousDeploymentPolicyId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The identifier of a continuous deployment policy. For more information, see CreateContinuousDeploymentPolicy.

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

The identifier of a continuous deployment policy. For more information, see CreateContinuousDeploymentPolicy.

" } }, "Staging": { "target": "com.amazonaws.cloudfront#boolean", "traits": { - "smithy.api#documentation": "

A Boolean that indicates whether this is a staging distribution. When this value is true, this is a staging distribution. When this value is false, this is not a staging distribution.

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

A Boolean that indicates whether this is a staging distribution. When this value is true, this is a staging distribution. When this value is false, this is not a staging distribution.

" } }, "AnycastIpListId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

ID of the Anycast static IP list that is associated with the distribution.

" + "smithy.api#documentation": "

To use this field for a multi-tenant distribution, use a connection group instead. For more information, see ConnectionGroup.

ID of the Anycast static IP list that is associated with the distribution.

" } }, "TenantConfig": { "target": "com.amazonaws.cloudfront#TenantConfig", "traits": { - "smithy.api#documentation": "

A distribution tenant configuration.

" + "smithy.api#documentation": "

This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

A distribution tenant configuration.

" } }, "ConnectionMode": { "target": "com.amazonaws.cloudfront#ConnectionMode", "traits": { - "smithy.api#documentation": "

The connection mode to filter distributions by.

" + "smithy.api#documentation": "

This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).

" } } }, @@ -8587,7 +8866,7 @@ } }, "Comment": { - "target": "com.amazonaws.cloudfront#string", + "target": "com.amazonaws.cloudfront#sensitiveStringType", "traits": { "smithy.api#documentation": "

The comment originally specified when this distribution was created.

", "smithy.api#required": {} @@ -8596,7 +8875,7 @@ "PriceClass": { "target": "com.amazonaws.cloudfront#PriceClass", "traits": { - "smithy.api#documentation": "

A complex type that contains information about price class for this streaming distribution.

", + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

A complex type that contains information about price class for this streaming distribution.

", "smithy.api#required": {} } }, @@ -8658,7 +8937,7 @@ "ConnectionMode": { "target": "com.amazonaws.cloudfront#ConnectionMode", "traits": { - "smithy.api#documentation": "

The connection mode to filter distributions by.

" + "smithy.api#documentation": "

This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).

" } }, "AnycastIpListId": { @@ -9658,7 +9937,7 @@ } }, "traits": { - "smithy.api#documentation": "

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.

" } }, "com.amazonaws.cloudfront#FrameOptionsList": { @@ -11194,7 +11473,7 @@ "type": "structure", "members": { "Name": { - "target": "com.amazonaws.cloudfront#string", + "target": "com.amazonaws.cloudfront#FunctionName", "traits": { "smithy.api#documentation": "

The name of the function whose code you are getting.

", "smithy.api#httpLabel": {}, @@ -13841,7 +14120,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.

Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide www.example.com as input, the returned list can include www.example.com and the overlapping wildcard alternate domain name (*.example.com), if they exist. If you provide *.example.com as input, the returned list can include *.example.com and any alternate domain names covered by that wildcard (for example, www.example.com, test.example.com, dev.example.com, and so on), if they exist.

To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

", + "smithy.api#documentation": "

The ListConflictingAliases API operation only supports standard distributions. To list domain conflicts for both standard distributions and distribution tenants, we recommend that you use the ListDomainConflicts API operation instead.

Gets a list of aliases that conflict or overlap with the provided alias, and the associated CloudFront standard distribution and Amazon Web Services accounts for each conflicting alias. An alias is commonly known as a custom domain or vanity domain. It can also be called a CNAME or alternate domain name.

In the returned list, the standard distribution and account IDs are partially hidden, which allows you to identify the standard distribution and accounts that you own, and helps to protect the information of ones that you don't own.

Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide www.example.com as input, the returned list can include www.example.com and the overlapping wildcard alternate domain name (*.example.com), if they exist. If you provide *.example.com as input, the returned list can include *.example.com and any alternate domain names covered by that wildcard (for example, www.example.com, test.example.com, dev.example.com, and so on), if they exist.

To list conflicting aliases, specify the alias to search and the ID of a standard distribution in your account that has an attached TLS certificate that includes the provided alias. For more information, including how to set up the standard distribution and certificate, see Moving an alternate domain name to a different standard distribution or distribution tenant in the Amazon CloudFront Developer Guide.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/conflicting-alias", @@ -13855,7 +14134,7 @@ "DistributionId": { "target": "com.amazonaws.cloudfront#distributionIdString", "traits": { - "smithy.api#documentation": "

The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.

", + "smithy.api#documentation": "

The ID of a standard distribution in your account that has an attached TLS certificate that includes the provided alias.

", "smithy.api#httpQuery": "DistributionId", "smithy.api#required": {} } @@ -14437,7 +14716,7 @@ "ConnectionMode": { "target": "com.amazonaws.cloudfront#ConnectionMode", "traits": { - "smithy.api#documentation": "

The connection mode to filter distributions by.

", + "smithy.api#documentation": "

This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14967,7 +15246,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists existing domain associations that conflict with the domain that you specify.

You can use this API operation when transferring domains to identify potential domain conflicts. Domain conflicts must be resolved first before they can be moved.

", + "smithy.api#documentation": "

We recommend that you use the ListDomainConflicts API operation to check for domain conflicts, as it supports both standard distributions and distribution tenants. ListConflictingAliases performs similar checks but only supports standard distributions.

Lists existing domain associations that conflict with the domain that you specify.

You can use this API operation to identify potential domain conflicts when moving domains between standard distributions and/or distribution tenants. Domain conflicts must be resolved first before they can be moved.

For example, if you provide www.example.com as input, the returned list can include www.example.com and the overlapping wildcard alternate domain name (*.example.com), if they exist. If you provide *.example.com as input, the returned list can include *.example.com and any alternate domain names covered by that wildcard (for example, www.example.com, test.example.com, dev.example.com, and so on), if they exist.

To list conflicting domains, specify the following:

  • The domain to search for

  • The ID of a standard distribution or distribution tenant in your account that has an attached TLS certificate, which covers the specified domain

For more information, including how to set up the standard distribution or distribution tenant, and the certificate, see Moving an alternate domain name to a different standard distribution or distribution tenant in the Amazon CloudFront Developer Guide.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/domain-conflicts", @@ -14994,7 +15273,7 @@ "DomainControlValidationResource": { "target": "com.amazonaws.cloudfront#DistributionResourceId", "traits": { - "smithy.api#documentation": "

The distribution resource identifier. This can be the distribution or distribution tenant that has a valid certificate, which covers the domain that you specify.

", + "smithy.api#documentation": "

The distribution resource identifier. This can be the standard distribution or distribution tenant that has a valid certificate, which covers the domain that you specify.

", "smithy.api#required": {} } }, @@ -15563,6 +15842,12 @@ "method": "GET", "uri": "/2020-05-31/origin-access-control", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "OriginAccessControlList.NextMarker", + "items": "OriginAccessControlList.Items", + "pageSize": "MaxItems" } } }, @@ -16680,6 +16965,12 @@ "smithy.api#documentation": "

The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.

For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.

" } }, + "ResponseCompletionTimeout": { + "target": "com.amazonaws.cloudfront#integer", + "traits": { + "smithy.api#documentation": "

The time (in seconds) that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection.

The value for ResponseCompletionTimeout must be equal to or greater than the value for OriginReadTimeout. If you don't set a value for ResponseCompletionTimeout, CloudFront doesn't enforce a maximum value.

For more information, see Response completion timeout in the Amazon CloudFront Developer Guide.

" + } + }, "OriginShield": { "target": "com.amazonaws.cloudfront#OriginShield", "traits": { @@ -18006,7 +18297,7 @@ "type": "structure", "members": { "Name": { - "target": "com.amazonaws.cloudfront#string", + "target": "com.amazonaws.cloudfront#FunctionName", "traits": { "smithy.api#documentation": "

The name of the function that you are publishing.

", "smithy.api#httpLabel": {}, @@ -19182,6 +19473,12 @@ "smithy.api#documentation": "

If you're using origin access control (OAC) instead of origin access identity, specify an empty OriginAccessIdentity element. For more information, see Restricting access to an Amazon Web Services in the Amazon CloudFront Developer Guide.

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

The ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

", "smithy.api#required": {} } + }, + "OriginReadTimeout": { + "target": "com.amazonaws.cloudfront#integer", + "traits": { + "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.

For more information, see Response timeout in the Amazon CloudFront Developer Guide.

" + } } }, "traits": { @@ -19220,6 +19517,14 @@ } } }, + "com.amazonaws.cloudfront#ServerCertificateId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 32 + } + } + }, "com.amazonaws.cloudfront#SessionStickinessConfig": { "type": "structure", "members": { @@ -19729,7 +20034,7 @@ "type": "structure", "members": { "Comment": { - "target": "com.amazonaws.cloudfront#string", + "target": "com.amazonaws.cloudfront#sensitiveStringType", "traits": { "smithy.api#documentation": "

A comment to describe the parameter.

" } @@ -19908,7 +20213,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration for a distribution tenant.

" + "smithy.api#documentation": "

This field only supports multi-tenant distributions. You can't specify this field for standard distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

The configuration for a distribution tenant.

" } }, "com.amazonaws.cloudfront#TestFunction": { @@ -19962,7 +20267,7 @@ "type": "structure", "members": { "Name": { - "target": "com.amazonaws.cloudfront#string", + "target": "com.amazonaws.cloudfront#FunctionName", "traits": { "smithy.api#documentation": "

The name of the function that you are testing.

", "smithy.api#httpLabel": {}, @@ -20956,7 +21261,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a cache policy configuration.

When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:

  1. Use GetCachePolicyConfig to get the current configuration.

  2. Locally modify the fields in the cache policy configuration that you want to update.

  3. Call UpdateCachePolicy by providing the entire cache policy configuration, including the fields that you modified and those that you didn't.

", + "smithy.api#documentation": "

Updates a cache policy configuration.

When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:

  1. Use GetCachePolicyConfig to get the current configuration.

  2. Locally modify the fields in the cache policy configuration that you want to update.

  3. Call UpdateCachePolicy by providing the entire cache policy configuration, including the fields that you modified and those that you didn't.

If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the Cache-Control: no-cache, no-store, or private directives are present in the origin headers.

", "smithy.api#http": { "method": "PUT", "uri": "/2020-05-31/cache-policy/{Id}", @@ -22013,7 +22318,7 @@ } ], "traits": { - "smithy.api#documentation": "

Moves a domain from its current distribution or distribution tenant to another one.

", + "smithy.api#documentation": "

We recommend that you use the UpdateDomainAssociation API operation to move a domain association, as it supports both standard distributions and distribution tenants. AssociateAlias performs similar checks but only supports standard distributions.

Moves a domain from its current standard distribution or distribution tenant to another one.

You must first disable the source distribution (standard distribution or distribution tenant) and then separately call this operation to move the domain to another target distribution (standard distribution or distribution tenant).

To use this operation, specify the domain and the ID of the target resource (standard distribution or distribution tenant). For more information, including how to set up the target resource, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different standard distribution or distribution tenant in the Amazon CloudFront Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/domain-association", @@ -22034,14 +22339,14 @@ "TargetResource": { "target": "com.amazonaws.cloudfront#DistributionResourceId", "traits": { - "smithy.api#documentation": "

The target distribution resource for the domain. You can specify either DistributionId or DistributionTenantId, but not both.

", + "smithy.api#documentation": "

The target standard distribution or distribution tenant resource for the domain. You can specify either DistributionId or DistributionTenantId, but not both.

", "smithy.api#required": {} } }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The value of the ETag identifier for the distribution or distribution tenant that will be associated with the domain.

", + "smithy.api#documentation": "

The value of the ETag identifier for the standard distribution or distribution tenant that will be associated with the domain.

", "smithy.api#httpHeader": "If-Match" } } @@ -22068,7 +22373,7 @@ "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "

The current version of the target distribution or distribution tenant that was associated with the domain.

", + "smithy.api#documentation": "

The current version of the target standard distribution or distribution tenant that was associated with the domain.

", "smithy.api#httpHeader": "ETag" } } @@ -22381,7 +22686,7 @@ "type": "structure", "members": { "Name": { - "target": "com.amazonaws.cloudfront#string", + "target": "com.amazonaws.cloudfront#FunctionName", "traits": { "smithy.api#documentation": "

The name of the function that you are updating.

", "smithy.api#httpLabel": {}, @@ -23516,9 +23821,9 @@ } }, "IAMCertificateId": { - "target": "com.amazonaws.cloudfront#string", + "target": "com.amazonaws.cloudfront#ServerCertificateId", "traits": { - "smithy.api#documentation": "

If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM), provide the ID of the IAM certificate.

If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.

" + "smithy.api#documentation": "

This field only supports standard distributions. You can't specify this field for multi-tenant distributions. For more information, see Unsupported features for SaaS Manager for Amazon CloudFront in the Amazon CloudFront Developer Guide.

If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM), provide the ID of the IAM certificate.

If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.

" } }, "ACMCertificateArn": { @@ -23644,13 +23949,13 @@ "OriginReadTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.

For more information, see Response timeout (custom origins only) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the origin response timeout. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 30 seconds.

For more information, see Response timeout in the Amazon CloudFront Developer Guide.

" } }, "OriginKeepaliveTimeout": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds.

For more information, see Keep-alive timeout (custom origins only) in the Amazon CloudFront Developer Guide.

" + "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 120 seconds, and the default (if you don't specify otherwise) is 5 seconds.

For more information, see Keep-alive timeout (custom origins only) in the Amazon CloudFront Developer Guide.

" } } }, diff --git a/codegen/sdk/aws-models/cloudwatch-logs.json b/codegen/sdk/aws-models/cloudwatch-logs.json index a26c0c5456f..7cd7bc71750 100644 --- a/codegen/sdk/aws-models/cloudwatch-logs.json +++ b/codegen/sdk/aws-models/cloudwatch-logs.json @@ -1266,6 +1266,9 @@ "target": "com.amazonaws.cloudwatchlogs#Arn" } }, + "com.amazonaws.cloudwatchlogs#Data": { + "type": "blob" + }, "com.amazonaws.cloudwatchlogs#DataAlreadyAcceptedException": { "type": "structure", "members": { @@ -3255,7 +3258,7 @@ "logGroupNamePattern": { "target": "com.amazonaws.cloudwatchlogs#LogGroupNamePattern", "traits": { - "smithy.api#documentation": "

If you specify a string for this parameter, the operation returns only log groups that\n have names that match the string based on a case-sensitive substring search. For example, if\n you specify DataLogs, log groups named DataLogs, aws/DataLogs, and\n GroupDataLogs would match, but datalogs, Data/log/s and\n Groupdata would not match.

\n

If you specify logGroupNamePattern in your request, then only\n arn, creationTime, and logGroupName are included in\n the response.

\n \n

\n logGroupNamePattern and logGroupNamePrefix are mutually exclusive.\n Only one of these parameters can be passed.

\n " + "smithy.api#documentation": "

If you specify a string for this parameter, the operation returns only log groups that\n have names that match the string based on a case-sensitive substring search. For example, if\n you specify DataLogs, log groups named DataLogs,\n aws/DataLogs, and GroupDataLogs would match, but\n datalogs, Data/log/s and Groupdata would not\n match.

\n

If you specify logGroupNamePattern in your request, then only\n arn, creationTime, and logGroupName are included in\n the response.

\n \n

\n logGroupNamePattern and logGroupNamePrefix are mutually exclusive.\n Only one of these parameters can be passed.

\n " } }, "nextToken": { @@ -4529,6 +4532,20 @@ "target": "com.amazonaws.cloudwatchlogs#FieldIndex" } }, + "com.amazonaws.cloudwatchlogs#FieldsData": { + "type": "structure", + "members": { + "data": { + "target": "com.amazonaws.cloudwatchlogs#Data", + "traits": { + "smithy.api#documentation": "

The actual log data content returned in the streaming response. This contains the fields and values of the log event in a structured format that can be parsed and processed by the client.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure containing the extracted fields from a log event. These fields are extracted based on the log format and can be used for structured querying and analysis.

" + } + }, "com.amazonaws.cloudwatchlogs#FilterCount": { "type": "integer" }, @@ -5435,6 +5452,88 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudwatchlogs#GetLogObject": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#GetLogObjectRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#GetLogObjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#AccessDeniedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a large logging object (LLO) and streams it back. This API is used to fetch the content of large portions of log events that have been ingested through the PutOpenTelemetryLogs API. \n When log events contain fields that would cause the total event size to exceed 1MB, CloudWatch Logs automatically processes up to 10 fields, starting with the largest fields. Each field is truncated as needed to keep \n the total event size as close to 1MB as possible. The excess portions are stored as Large Log Objects (LLOs) and these fields are processed separately and LLO reference system fields (in the format @ptr.$[path.to.field]) are \n added. The path in the reference field reflects the original JSON structure where the large field was located. For example, this could be @ptr.$['input']['message'], @ptr.$['AAA']['BBB']['CCC']['DDD'], @ptr.$['AAA'], or any other path matching your log structure.

", + "smithy.api#endpoint": { + "hostPrefix": "streaming-" + } + } + }, + "com.amazonaws.cloudwatchlogs#GetLogObjectRequest": { + "type": "structure", + "members": { + "unmask": { + "target": "com.amazonaws.cloudwatchlogs#Unmask", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean flag that indicates whether to unmask sensitive log data. When set to true, any masked or redacted data in the log object will be displayed in its original form. Default is false.

" + } + }, + "logObjectPointer": { + "target": "com.amazonaws.cloudwatchlogs#LogObjectPointer", + "traits": { + "smithy.api#documentation": "

A pointer to the specific log object to retrieve. This is a required parameter that uniquely identifies the log object within CloudWatch Logs. The pointer is typically obtained from a previous query or filter operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for the GetLogObject operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogObjectResponse": { + "type": "structure", + "members": { + "fieldStream": { + "target": "com.amazonaws.cloudwatchlogs#GetLogObjectResponseStream" + } + }, + "traits": { + "smithy.api#documentation": "

The response from the GetLogObject operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudwatchlogs#GetLogObjectResponseStream": { + "type": "union", + "members": { + "fields": { + "target": "com.amazonaws.cloudwatchlogs#FieldsData" + }, + "InternalStreamingException": { + "target": "com.amazonaws.cloudwatchlogs#InternalStreamingException" + } + }, + "traits": { + "smithy.api#documentation": "

A stream of structured log data returned by the GetLogObject operation. This stream contains log events with their associated metadata and extracted fields.

", + "smithy.api#streaming": {} + } + }, "com.amazonaws.cloudwatchlogs#GetLogRecord": { "type": "operation", "input": { @@ -5937,6 +6036,18 @@ "com.amazonaws.cloudwatchlogs#Interleaved": { "type": "boolean" }, + "com.amazonaws.cloudwatchlogs#InternalStreamingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.cloudwatchlogs#Message" + } + }, + "traits": { + "smithy.api#documentation": "

An internal error occurred during the streaming of log data. This exception is thrown when there's an issue with the internal streaming mechanism used by the GetLogObject operation.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.cloudwatchlogs#InvalidOperationException": { "type": "structure", "members": { @@ -6965,6 +7076,15 @@ "target": "com.amazonaws.cloudwatchlogs#LogGroup" } }, + "com.amazonaws.cloudwatchlogs#LogObjectPointer": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, "com.amazonaws.cloudwatchlogs#LogRecord": { "type": "map", "key": { @@ -7243,6 +7363,9 @@ { "target": "com.amazonaws.cloudwatchlogs#GetLogGroupFields" }, + { + "target": "com.amazonaws.cloudwatchlogs#GetLogObject" + }, { "target": "com.amazonaws.cloudwatchlogs#GetLogRecord" }, @@ -9334,13 +9457,13 @@ "source": { "target": "com.amazonaws.cloudwatchlogs#Source", "traits": { - "smithy.api#documentation": "

The path to the field in the log event that you want to parse. If you omit this value, the whole log message is parsed.

" + "smithy.api#documentation": "

The path to the field in the log event that you want to parse. If you omit this value, the\n whole log message is parsed.

" } }, "eventSource": { "target": "com.amazonaws.cloudwatchlogs#EventSource", "traits": { - "smithy.api#documentation": "

Specify the service or process that produces the log events that will be converted with this processor.

", + "smithy.api#documentation": "

Specify the service or process that produces the log events that will be converted with\n this processor.

", "smithy.api#required": {} } }, @@ -9353,7 +9476,7 @@ } }, "traits": { - "smithy.api#documentation": "

This processor converts logs into Open Cybersecurity Schema Framework (OCSF) events.

\n

For more information about this processor including examples, see \n parseToOSCF in the CloudWatch Logs User Guide.

" + "smithy.api#documentation": "

This processor converts logs into Open Cybersecurity Schema\n Framework (OCSF) events.

\n

For more information about this processor including examples, see parseToOSCF in the CloudWatch Logs User Guide.

" } }, "com.amazonaws.cloudwatchlogs#ParseVPC": { @@ -9542,6 +9665,12 @@ "traits": { "smithy.api#enumValue": "TRANSFORMER_POLICY" } + }, + "METRIC_EXTRACTION_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METRIC_EXTRACTION_POLICY" + } } } }, @@ -9734,7 +9863,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an account-level data protection policy, subscription filter policy, or field\n index policy that applies to all log groups or a subset of log groups in the account.

\n

To use this operation, you must be signed on with the correct permissions depending on the\n type of policy that you are creating.

\n
    \n
  • \n

    To create a data protection policy, you must have the\n logs:PutDataProtectionPolicy and logs:PutAccountPolicy\n permissions.

    \n
    • \n
  • \n

    To create a subscription filter policy, you must have the\n logs:PutSubscriptionFilter and logs:PutAccountPolicy\n permissions.

    \n
    • \n
  • \n

    To create a transformer policy, you must have the logs:PutTransformer and\n logs:PutAccountPolicy permissions.

    \n
    • \n
  • \n

    To create a field index policy, you must have the logs:PutIndexPolicy and\n logs:PutAccountPolicy permissions.

    \n
    • \n
\n

\n Data protection policy\n

\n

A data protection policy can help safeguard sensitive data that's ingested by your log\n groups by auditing and masking the sensitive log data. Each account can have only one\n account-level data protection policy.

\n \n

Sensitive data is detected and masked when it is ingested into a log group. When you set\n a data protection policy, log events ingested into the log groups before that time are not\n masked.

\n \n

If you use PutAccountPolicy to create a data protection policy for your whole\n account, it applies to both existing log groups and all log groups that are created later in\n this account. The account-level policy is applied to existing log groups with eventual\n consistency. It might take up to 5 minutes before sensitive data in existing log groups begins\n to be masked.

\n

By default, when a user views a log event that includes masked data, the sensitive data is\n replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to\n true to view the unmasked log events. Users with the logs:Unmask\n can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs\n Insights query with the unmask query command.

\n

For more information, including a list of types of data that can be audited and masked,\n see Protect sensitive log data\n with masking.

\n

To use the PutAccountPolicy operation for a data protection policy, you must\n be signed on with the logs:PutDataProtectionPolicy and\n logs:PutAccountPolicy permissions.

\n

The PutAccountPolicy operation applies to all log groups in the account. You\n can use PutDataProtectionPolicy to create a data protection policy that applies to just one\n log group. If a log group has its own data protection policy and the account also has an\n account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.

\n

\n Subscription filter policy\n

\n

A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to\n both existing log groups and log groups that are created later in this account. Supported\n destinations are Kinesis Data Streams, Firehose, and Lambda. When log\n events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP\n format.

\n

The following destinations are supported for subscription filters:

\n
    \n
  • \n

    An Kinesis Data Streams data stream in the same account as the subscription policy, for\n same-account delivery.

    \n
    • \n
  • \n

    An Firehose data stream in the same account as the subscription policy, for\n same-account delivery.

    \n
    • \n
  • \n

    A Lambda function in the same account as the subscription policy, for\n same-account delivery.

    \n
    • \n
  • \n

    A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.

    \n
    • \n
\n

Each account can have one account-level subscription filter policy per Region. If you are\n updating an existing filter, you must specify the correct name in PolicyName. To\n perform a PutAccountPolicy subscription filter operation for any destination\n except a Lambda function, you must also have the iam:PassRole\n permission.

\n

\n Transformer policy\n

\n

Creates or updates a log transformer policy for your account. You use\n log transformers to transform log events into a different format, making them easier for you\n to process and analyze. You can also transform logs from different sources into standardized\n formats that contain relevant, source-specific information. After you have created a\n transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You\n can then refer to the transformed versions of the logs during operations such as querying with\n CloudWatch Logs Insights or creating metric filters or subscription filters.

\n

You can also use a transformer to copy metadata from metadata keys into the log events\n themselves. This metadata can include log group name, log stream name, account ID and\n Region.

\n

A transformer for a log group is a series of processors, where each processor applies one\n type of transformation to the log events ingested into this log group. For more information\n about the available processors to use in a transformer, see Processors that you can use.

\n

Having log events in standardized format enables visibility across your applications for\n your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation\n for common log types with out-of-the-box transformation templates for major Amazon Web Services\n log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use\n pre-built transformation templates or create custom transformation policies.

\n

You can create transformers only for the log groups in the Standard log class.

\n

You can have one account-level transformer policy that applies to all log groups in the\n account. Or you can create as many as 20 account-level transformer policies that are each\n scoped to a subset of log groups with the selectionCriteria parameter. If you\n have multiple account-level transformer policies with selection criteria, no two of them can\n use the same or overlapping log group name prefixes. For example, if you have one policy\n filtered to log groups that start with my-log, you can't have another field index\n policy filtered to my-logpprod or my-logging.

\n

You can also set up a transformer at the log-group level. For more information, see PutTransformer. If there is both a log-group level transformer created with\n PutTransformer and an account-level transformer that could apply to the same\n log group, the log group uses only the log-group level transformer. It ignores the\n account-level transformer.

\n

\n Field index policy\n

\n

You can use field index policies to create indexes on fields found in log events in the\n log group. Creating field indexes can help lower the scan volume for CloudWatch Logs\n Insights queries that reference those fields, because these queries attempt to skip the\n processing of log events that are known to not match the indexed field. Good fields to index\n are fields that you often need to query for and fields or values that match only a small\n fraction of the total log events. Common examples of indexes include request ID, session ID,\n user IDs, or instance IDs. For more information, see Create field indexes\n to improve query performance and reduce costs\n

\n

To find the fields that are in your log group events, use the GetLogGroupFields operation.

\n

For example, suppose you have created a field index for requestId. Then, any\n CloudWatch Logs Insights query on that log group that includes requestId =\n value\n or requestId in [value,\n value, ...] will attempt to process only the log events where\n the indexed field matches the specified value.

\n

Matches of log events to the names of indexed fields are case-sensitive. For example, an\n indexed field of RequestId won't match a log event containing\n requestId.

\n

You can have one account-level field index policy that applies to all log groups in the\n account. Or you can create as many as 20 account-level field index policies that are each\n scoped to a subset of log groups with the selectionCriteria parameter. If you\n have multiple account-level index policies with selection criteria, no two of them can use the\n same or overlapping log group name prefixes. For example, if you have one policy filtered to\n log groups that start with my-log, you can't have another field index policy\n filtered to my-logpprod or my-logging.

\n

If you create an account-level field index policy in a monitoring account in cross-account\n observability, the policy is applied only to the monitoring account and not to any source\n accounts.

\n

If you want to create a field index policy for a single log group, you can use PutIndexPolicy instead of PutAccountPolicy. If you do so, that log\n group will use only that log-group level policy, and will ignore the account-level policy that\n you create with PutAccountPolicy.

" + "smithy.api#documentation": "

Creates an account-level data protection policy, subscription filter policy, field index\n policy, transformer policy, or metric extraction policy that applies to all log groups or a\n subset of log groups in the account.

\n

To use this operation, you must be signed on with the correct permissions depending on the\n type of policy that you are creating.

\n
    \n
  • \n

    To create a data protection policy, you must have the\n logs:PutDataProtectionPolicy and logs:PutAccountPolicy\n permissions.

    \n
    • \n
  • \n

    To create a subscription filter policy, you must have the\n logs:PutSubscriptionFilter and logs:PutAccountPolicy\n permissions.

    \n
    • \n
  • \n

    To create a transformer policy, you must have the logs:PutTransformer and\n logs:PutAccountPolicy permissions.

    \n
    • \n
  • \n

    To create a field index policy, you must have the logs:PutIndexPolicy and\n logs:PutAccountPolicy permissions.

    \n
    • \n
  • \n

    To create a metric extraction policy, you must have the\n logs:PutMetricExtractionPolicy and\n logs:PutAccountPolicy permissions.

    \n
    • \n
\n

\n Data protection policy\n

\n

A data protection policy can help safeguard sensitive data that's ingested by your log\n groups by auditing and masking the sensitive log data. Each account can have only one\n account-level data protection policy.

\n \n

Sensitive data is detected and masked when it is ingested into a log group. When you set\n a data protection policy, log events ingested into the log groups before that time are not\n masked.

\n \n

If you use PutAccountPolicy to create a data protection policy for your whole\n account, it applies to both existing log groups and all log groups that are created later in\n this account. The account-level policy is applied to existing log groups with eventual\n consistency. It might take up to 5 minutes before sensitive data in existing log groups begins\n to be masked.

\n

By default, when a user views a log event that includes masked data, the sensitive data is\n replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to\n true to view the unmasked log events. Users with the logs:Unmask\n can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs\n Insights query with the unmask query command.

\n

For more information, including a list of types of data that can be audited and masked,\n see Protect sensitive log data\n with masking.

\n

To use the PutAccountPolicy operation for a data protection policy, you must\n be signed on with the logs:PutDataProtectionPolicy and\n logs:PutAccountPolicy permissions.

\n

The PutAccountPolicy operation applies to all log groups in the account. You\n can use PutDataProtectionPolicy to create a data protection policy that applies to just one\n log group. If a log group has its own data protection policy and the account also has an\n account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.

\n

\n Subscription filter policy\n

\n

A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to\n both existing log groups and log groups that are created later in this account. Supported\n destinations are Kinesis Data Streams, Firehose, and Lambda. When log\n events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP\n format.

\n

The following destinations are supported for subscription filters:

\n
    \n
  • \n

    An Kinesis Data Streams data stream in the same account as the subscription policy, for\n same-account delivery.

    \n
    • \n
  • \n

    An Firehose data stream in the same account as the subscription policy, for\n same-account delivery.

    \n
    • \n
  • \n

    A Lambda function in the same account as the subscription policy, for\n same-account delivery.

    \n
    • \n
  • \n

    A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.

    \n
    • \n
\n

Each account can have one account-level subscription filter policy per Region. If you are\n updating an existing filter, you must specify the correct name in PolicyName. To\n perform a PutAccountPolicy subscription filter operation for any destination\n except a Lambda function, you must also have the iam:PassRole\n permission.

\n

\n Transformer policy\n

\n

Creates or updates a log transformer policy for your account. You use\n log transformers to transform log events into a different format, making them easier for you\n to process and analyze. You can also transform logs from different sources into standardized\n formats that contain relevant, source-specific information. After you have created a\n transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You\n can then refer to the transformed versions of the logs during operations such as querying with\n CloudWatch Logs Insights or creating metric filters or subscription filters.

\n

You can also use a transformer to copy metadata from metadata keys into the log events\n themselves. This metadata can include log group name, log stream name, account ID and\n Region.

\n

A transformer for a log group is a series of processors, where each processor applies one\n type of transformation to the log events ingested into this log group. For more information\n about the available processors to use in a transformer, see Processors that you can use.

\n

Having log events in standardized format enables visibility across your applications for\n your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation\n for common log types with out-of-the-box transformation templates for major Amazon Web Services\n log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use\n pre-built transformation templates or create custom transformation policies.

\n

You can create transformers only for the log groups in the Standard log class.

\n

You can have one account-level transformer policy that applies to all log groups in the\n account. Or you can create as many as 20 account-level transformer policies that are each\n scoped to a subset of log groups with the selectionCriteria parameter. If you\n have multiple account-level transformer policies with selection criteria, no two of them can\n use the same or overlapping log group name prefixes. For example, if you have one policy\n filtered to log groups that start with my-log, you can't have another field index\n policy filtered to my-logpprod or my-logging.

\n

You can also set up a transformer at the log-group level. For more information, see PutTransformer. If there is both a log-group level transformer created with\n PutTransformer and an account-level transformer that could apply to the same\n log group, the log group uses only the log-group level transformer. It ignores the\n account-level transformer.

\n

\n Field index policy\n

\n

You can use field index policies to create indexes on fields found in log events in the\n log group. Creating field indexes can help lower the scan volume for CloudWatch Logs\n Insights queries that reference those fields, because these queries attempt to skip the\n processing of log events that are known to not match the indexed field. Good fields to index\n are fields that you often need to query for and fields or values that match only a small\n fraction of the total log events. Common examples of indexes include request ID, session ID,\n user IDs, or instance IDs. For more information, see Create field indexes\n to improve query performance and reduce costs\n

\n

To find the fields that are in your log group events, use the GetLogGroupFields operation.

\n

For example, suppose you have created a field index for requestId. Then, any\n CloudWatch Logs Insights query on that log group that includes requestId =\n value\n or requestId in [value,\n value, ...] will attempt to process only the log events where\n the indexed field matches the specified value.

\n

Matches of log events to the names of indexed fields are case-sensitive. For example, an\n indexed field of RequestId won't match a log event containing\n requestId.

\n

You can have one account-level field index policy that applies to all log groups in the\n account. Or you can create as many as 20 account-level field index policies that are each\n scoped to a subset of log groups with the selectionCriteria parameter. If you\n have multiple account-level index policies with selection criteria, no two of them can use the\n same or overlapping log group name prefixes. For example, if you have one policy filtered to\n log groups that start with my-log, you can't have another field index policy\n filtered to my-logpprod or my-logging.

\n

If you create an account-level field index policy in a monitoring account in cross-account\n observability, the policy is applied only to the monitoring account and not to any source\n accounts.

\n

If you want to create a field index policy for a single log group, you can use PutIndexPolicy instead of PutAccountPolicy. If you do so, that log\n group will use only that log-group level policy, and will ignore the account-level policy that\n you create with PutAccountPolicy.

\n

\n Metric extraction policy\n

\n

A metric extraction policy controls whether CloudWatch Metrics can be created through the\n Embedded Metrics Format (EMF) for log groups in your account. By default, EMF metric creation\n is enabled for all log groups. You can use metric extraction policies to disable EMF metric\n creation for your entire account or specific log groups.

\n

When a policy disables EMF metric creation for a log group, log events in the EMF format\n are still ingested, but no CloudWatch Metrics are created from them.

\n \n

Creating a policy disables metrics for AWS features that use EMF to create metrics, such\n as CloudWatch Container Insights and CloudWatch Application Signals. To prevent turning off\n those features by accident, we recommend that you exclude the underlying log-groups through a\n selection-criteria such as LogGroupNamePrefix NOT IN [\"/aws/containerinsights\",\n \"/aws/ecs/containerinsights\", \"/aws/application-signals/data\"].

\n \n

Each account can have either one account-level metric extraction policy that applies to\n all log groups, or up to 5 policies that are each scoped to a subset of log groups with the\n selectionCriteria parameter. The selection criteria supports filtering by LogGroupName and\n LogGroupNamePrefix using the operators IN and NOT IN. You can specify up to 50 values in each\n IN or NOT IN list.

\n

The selection criteria can be specified in these formats:

\n

\n LogGroupName IN [\"log-group-1\", \"log-group-2\"]\n

\n

\n LogGroupNamePrefix NOT IN [\"/aws/prefix1\", \"/aws/prefix2\"]\n

\n

If you have multiple account-level metric extraction policies with selection criteria, no\n two of them can have overlapping criteria. For example, if you have one policy with selection\n criteria LogGroupNamePrefix IN [\"my-log\"], you can't have another metric extraction policy\n with selection criteria LogGroupNamePrefix IN [\"/my-log-prod\"] or LogGroupNamePrefix IN\n [\"/my-logging\"], as the set of log groups matching these prefixes would be a subset of the log\n groups matching the first policy's prefix, creating an overlap.

\n

When using NOT IN, only one policy with this operator is allowed per account.

\n

When combining policies with IN and NOT IN operators, the overlap check ensures that\n policies don't have conflicting effects. Two policies with IN and NOT IN operators do not\n overlap if and only if every value in the IN policy is completely contained within some value\n in the NOT IN policy. For example:

\n
    \n
  • \n

    If you have a NOT IN policy for prefix \"/aws/lambda\", you can create an IN policy for\n the exact log group name \"/aws/lambda/function1\" because the set of log groups matching\n \"/aws/lambda/function1\" is a subset of the log groups matching \"/aws/lambda\".

    \n
    • \n
  • \n

    If you have a NOT IN policy for prefix \"/aws/lambda\", you cannot create an IN policy\n for prefix \"/aws\" because the set of log groups matching \"/aws\" is not a subset of the log\n groups matching \"/aws/lambda\".

    \n
    • \n
" } }, "com.amazonaws.cloudwatchlogs#PutAccountPolicyRequest": { @@ -9770,7 +9899,7 @@ "selectionCriteria": { "target": "com.amazonaws.cloudwatchlogs#SelectionCriteria", "traits": { - "smithy.api#documentation": "

Use this parameter to apply the new policy to a subset of log groups in the\n account.

\n

Specifing selectionCriteria is valid only when you specify\n SUBSCRIPTION_FILTER_POLICY, FIELD_INDEX_POLICY or\n TRANSFORMER_POLICYfor policyType.

\n

If policyType is SUBSCRIPTION_FILTER_POLICY, the only supported\n selectionCriteria filter is LogGroupName NOT IN []\n

\n

If policyType is FIELD_INDEX_POLICY or\n TRANSFORMER_POLICY, the only supported selectionCriteria filter is\n LogGroupNamePrefix\n

\n

The selectionCriteria string can be up to 25KB in length. The length is\n determined by using its UTF-8 bytes.

\n

Using the selectionCriteria parameter with\n SUBSCRIPTION_FILTER_POLICY is useful to help prevent infinite loops. For more\n information, see Log recursion\n prevention.

" + "smithy.api#documentation": "

Use this parameter to apply the new policy to a subset of log groups in the\n account.

\n

Specifying selectionCriteria is valid only when you specify\n SUBSCRIPTION_FILTER_POLICY, FIELD_INDEX_POLICY or\n TRANSFORMER_POLICYfor policyType.

\n

If policyType is SUBSCRIPTION_FILTER_POLICY, the only supported\n selectionCriteria filter is LogGroupName NOT IN []\n

\n

If policyType is FIELD_INDEX_POLICY or\n TRANSFORMER_POLICY, the only supported selectionCriteria filter is\n LogGroupNamePrefix\n

\n

The selectionCriteria string can be up to 25KB in length. The length is\n determined by using its UTF-8 bytes.

\n

Using the selectionCriteria parameter with\n SUBSCRIPTION_FILTER_POLICY is useful to help prevent infinite loops. For more\n information, see Log recursion\n prevention.

" } } }, @@ -10068,7 +10197,7 @@ "logType": { "target": "com.amazonaws.cloudwatchlogs#LogType", "traits": { - "smithy.api#documentation": "

Defines the type of log that the source is sending.

\n
    \n
  • \n

    For Amazon Bedrock, the valid value is APPLICATION_LOGS and TRACES.

    \n
    • \n
  • \n

    For CloudFront, the valid value is ACCESS_LOGS.

    \n
    • \n
  • \n

    For Amazon CodeWhisperer, the valid value is EVENT_LOGS.

    \n
    • \n
  • \n

    For Elemental MediaPackage, the valid values are EGRESS_ACCESS_LOGS and\n INGRESS_ACCESS_LOGS.

    \n
    • \n
  • \n

    For Elemental MediaTailor, the valid values are AD_DECISION_SERVER_LOGS,\n MANIFEST_SERVICE_LOGS, and TRANSCODE_LOGS.

    \n
    • \n
  • \n

    For Entity Resolution, the valid value is WORKFLOW_LOGS.

    \n
    • \n
  • \n

    For IAM Identity Center, the valid value is\n ERROR_LOGS.

    \n
    • \n
  • \n

    For PCS, the valid values are PCS_SCHEDULER_LOGS and PCS_JOBCOMP_LOGS.

    \n
    • \n
  • \n

    For Amazon Q, the valid value is EVENT_LOGS.

    \n
    • \n
  • \n

    For Amazon SES mail manager, the valid values are APPLICATION_LOG\n and TRAFFIC_POLICY_DEBUG_LOGS.

    \n
    • \n
  • \n

    For Amazon WorkMail, the valid values are ACCESS_CONTROL_LOGS,\n AUTHENTICATION_LOGS, WORKMAIL_AVAILABILITY_PROVIDER_LOGS,\n WORKMAIL_MAILBOX_ACCESS_LOGS, and\n WORKMAIL_PERSONAL_ACCESS_TOKEN_LOGS.

    \n
    • \n
  • \n

    For Amazon VPC Route Server, the valid value is\n EVENT_LOGS.

    \n
    • \n
", + "smithy.api#documentation": "

Defines the type of log that the source is sending.

\n
    \n
  • \n

    For Amazon Bedrock, the valid value is APPLICATION_LOGS and TRACES.

    \n
    • \n
  • \n

    For CloudFront, the valid value is ACCESS_LOGS.

    \n
    • \n
  • \n

    For Amazon CodeWhisperer, the valid value is EVENT_LOGS.

    \n
    • \n
  • \n

    For Elemental MediaPackage, the valid values are EGRESS_ACCESS_LOGS and\n INGRESS_ACCESS_LOGS.

    \n
    • \n
  • \n

    For Elemental MediaTailor, the valid values are AD_DECISION_SERVER_LOGS,\n MANIFEST_SERVICE_LOGS, and TRANSCODE_LOGS.

    \n
    • \n
  • \n

    For Entity Resolution, the valid value is WORKFLOW_LOGS.

    \n
    • \n
  • \n

    For IAM Identity Center, the valid value is\n ERROR_LOGS.

    \n
    • \n
  • \n

    For PCS, the valid values are PCS_SCHEDULER_LOGS and\n PCS_JOBCOMP_LOGS.

    \n
    • \n
  • \n

    For Amazon Q, the valid value is EVENT_LOGS.

    \n
    • \n
  • \n

    For Amazon SES mail manager, the valid values are APPLICATION_LOG\n and TRAFFIC_POLICY_DEBUG_LOGS.

    \n
    • \n
  • \n

    For Amazon WorkMail, the valid values are ACCESS_CONTROL_LOGS,\n AUTHENTICATION_LOGS, WORKMAIL_AVAILABILITY_PROVIDER_LOGS,\n WORKMAIL_MAILBOX_ACCESS_LOGS, and\n WORKMAIL_PERSONAL_ACCESS_TOKEN_LOGS.

    \n
    • \n
  • \n

    For Amazon VPC Route Server, the valid value is\n EVENT_LOGS.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -12981,7 +13110,7 @@ "smithy.api#deprecated": { "message": "Please use the generic tagging API UntagResource" }, - "smithy.api#documentation": "\n

The UntagLogGroup operation is on the path to deprecation. We recommend that you use\n UntagResource instead.

\n \n

Removes the specified tags from the specified log group.

\n

To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.

\n

CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified\n tags to log groups using the aws:Resource/key-name\n or\n aws:TagKeys condition keys.

" + "smithy.api#documentation": "\n

The UntagLogGroup operation is on the path to deprecation. We recommend that you use\n UntagResource instead.

\n \n

Removes the specified tags from the specified log group.

\n

To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.

\n

When using IAM policies to control tag management for CloudWatch Logs log groups, the\n condition keys aws:Resource/key-name and aws:TagKeys cannot be used to restrict which tags\n users can assign.

" } }, "com.amazonaws.cloudwatchlogs#UntagLogGroupRequest": { diff --git a/codegen/sdk/aws-models/codeconnections.json b/codegen/sdk/aws-models/codeconnections.json index b98ddba7acf..884c37ddfb0 100644 --- a/codegen/sdk/aws-models/codeconnections.json +++ b/codegen/sdk/aws-models/codeconnections.json @@ -917,7 +917,7 @@ "ConnectionArn": { "target": "com.amazonaws.codeconnections#ConnectionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection\n reference when the connection is shared between Amazon Web Servicesservices.

\n \n

The ARN is never reused if the connection is deleted.

\n " + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection\n reference when the connection is shared between Amazon Web Services services.

\n \n

The ARN is never reused if the connection is deleted.

\n " } }, "ProviderType": { @@ -2703,6 +2703,12 @@ "traits": { "smithy.api#enumValue": "GitLabSelfManaged" } + }, + "AZURE_DEV_OPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AzureDevOps" + } } } }, diff --git a/codegen/sdk/aws-models/config-service.json b/codegen/sdk/aws-models/config-service.json index 1ae8b01e416..e3f6e81063a 100644 --- a/codegen/sdk/aws-models/config-service.json +++ b/codegen/sdk/aws-models/config-service.json @@ -859,19 +859,19 @@ "configuration": { "target": "com.amazonaws.configservice#Configuration", "traits": { - "smithy.api#documentation": "

The description of the resource configuration.

" + "smithy.api#documentation": "

A JSON-encoded string that contains the contents for the resource configuration. This string needs to be deserialized using json.loads() before you can access the contents.\n

" } }, "supplementaryConfiguration": { "target": "com.amazonaws.configservice#SupplementaryConfiguration", "traits": { - "smithy.api#documentation": "

Configuration attributes that Config returns for certain\n\t\t\tresource types to supplement the information returned for the\n\t\t\tconfiguration parameter.

" + "smithy.api#documentation": "

A string to string map that contains additional contents for the resource configuration.Config returns this field for certain\n\t\t\tresource types to supplement the information returned for the\n\t\t\tconfiguration field.

\n

This string needs to be deserialized using json.loads() before you can access the contents.

" } }, "recordingFrequency": { "target": "com.amazonaws.configservice#RecordingFrequency", "traits": { - "smithy.api#documentation": "

The recording frequency that Config uses to record configuration changes for the resource.

" + "smithy.api#documentation": "

The recording frequency that Config uses to record configuration changes for the resource.

\n \n

This field only appears in the API response when DAILY recording is enabled for a resource type.\n\t\t\t\tIf this field is not present, CONTINUOUS recording is enabled for that resource type. For more information on daily recording and continuous recording, see Recording Frequency in the Config\n\t\t\t\t\t\tDeveloper Guide.

\n " } }, "configurationItemDeliveryTime": { @@ -1340,7 +1340,7 @@ "Scope": { "target": "com.amazonaws.configservice#Scope", "traits": { - "smithy.api#documentation": "

Defines which resources can trigger an evaluation for the rule.\n\t\t\tThe scope can include one or more resource types, a combination of\n\t\t\tone resource type and one resource ID, or a combination of a tag key\n\t\t\tand value. Specify a scope to constrain the resources that can\n\t\t\ttrigger an evaluation for the rule. If you do not specify a scope,\n\t\t\tevaluations are triggered when any resource in the recording group\n\t\t\tchanges.

\n \n

The scope can be empty.

\n " + "smithy.api#documentation": "

Defines which resources can trigger an evaluation for the rule.\n\t\t\tThe scope can include one or more resource types, a combination of\n\t\t\tone resource type and one resource ID, or a combination of a tag key\n\t\t\tand value. Specify a scope to constrain the resources that can\n\t\t\ttrigger an evaluation for the rule. If you do not specify a scope,\n\t\t\tevaluations are triggered when any resource in the recording group\n\t\t\tchanges.

" } }, "Source": { @@ -1857,25 +1857,25 @@ "configuration": { "target": "com.amazonaws.configservice#Configuration", "traits": { - "smithy.api#documentation": "

The description of the resource configuration.

" + "smithy.api#documentation": "

A JSON-encoded string that contains the contents for the resource configuration. This string needs to be deserialized using json.loads() before you can access the contents.

" } }, "supplementaryConfiguration": { "target": "com.amazonaws.configservice#SupplementaryConfiguration", "traits": { - "smithy.api#documentation": "

Configuration attributes that Config returns for certain\n\t\t\tresource types to supplement the information returned for the\n\t\t\t\tconfiguration parameter.

" + "smithy.api#documentation": "

A string to string map that contains additional contents for the resource configuration.Config returns this field for certain\n\t\t\tresource types to supplement the information returned for the\n\t\t\tconfiguration field.

\n

This string to string map needs to be deserialized using json.loads() before you can accessing the contents.

" } }, "recordingFrequency": { "target": "com.amazonaws.configservice#RecordingFrequency", "traits": { - "smithy.api#documentation": "

The recording frequency that Config uses to record configuration changes for the resource.

" + "smithy.api#documentation": "

The recording frequency that Config uses to record configuration changes for the resource.

\n \n

This field only appears in the API response when DAILY recording is enabled for a resource type.\n\t\t\t\tIf this field is not present, CONTINUOUS recording is enabled for that resource type. For more information on daily recording and continuous recording, see Recording Frequency in the Config\n\t\t\t\t\t\tDeveloper Guide.

\n " } }, "configurationItemDeliveryTime": { "target": "com.amazonaws.configservice#ConfigurationItemDeliveryTime", "traits": { - "smithy.api#documentation": "

The time when configuration changes for the resource were delivered.

\n \n

This field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording,\n\t\t\tthis field will be populated. However, if you are using continuous recording,\n\t\t\tthis field will be omitted since the delivery time is instantaneous as the CI is available right away. For more information on daily recording and continuous recording, see Recording Frequency in the Config\n\t\t\t\t\tDeveloper Guide.

\n " + "smithy.api#documentation": "

The time when configuration changes for the resource were delivered.

\n \n

This field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording,\n\t\t\tthis field will be populated. However, if you are using continuous recording,\n\t\t\tthis field will be omitted since the delivery time is instantaneous as the CI is available right away.

\n

For more information on daily recording and continuous recording, see Recording Frequency in the Config\n\t\t\t\t\tDeveloper Guide.

\n " } } }, @@ -1945,7 +1945,7 @@ "name": { "target": "com.amazonaws.configservice#RecorderName", "traits": { - "smithy.api#documentation": "

The name of the configuration recorder.

\n

For customer managed configuration recorders, Config automatically assigns the name of \"default\" when creating a configuration recorder if you do not specify a name at creation time.

\n

For service-linked configuration recorders, Config automatically assigns a name that has the prefix \"AWS\" to a new service-linked configuration recorder.

\n \n

\n Changing the name of a configuration recorder\n

\n

To change the name of the customer managed configuration recorder, you must delete it and create a new customer managed configuration recorder with a new name.

\n

You cannot change the name of a service-linked configuration recorder.

\n " + "smithy.api#documentation": "

The name of the configuration recorder.

\n

For customer managed configuration recorders, Config automatically assigns the name of \"default\" when creating a configuration recorder if you do not specify a name at creation time.

\n

For service-linked configuration recorders, Config automatically assigns a name that has the prefix \"AWSConfigurationRecorderFor\" to a new service-linked configuration recorder.

\n \n

\n Changing the name of a configuration recorder\n

\n

To change the name of the customer managed configuration recorder, you must delete it and create a new customer managed configuration recorder with a new name.

\n

You cannot change the name of a service-linked configuration recorder.

\n " } }, "roleARN": { @@ -2879,7 +2879,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified Config rule and all of its evaluation\n\t\t\tresults.

\n

Config sets the state of a rule to DELETING\n\t\t\tuntil the deletion is complete. You cannot update a rule while it is\n\t\t\tin this state. If you make a PutConfigRule or\n\t\t\t\tDeleteConfigRule request for the rule, you will\n\t\t\treceive a ResourceInUseException.

\n

You can check the state of a rule by using the\n\t\t\t\tDescribeConfigRules request.

\n \n

\n Recommendation: Stop recording resource compliance before deleting rules\n

\n

It is highly recommended that you stop recording for the AWS::Config::ResourceCompliance resource type before you delete rules in your account.\n\t\t\t\tDeleting rules creates CIs for AWS::Config::ResourceCompliance and can affect your Config configuration recorder costs.\n\t\t\t\t\n\t\t\t\tIf you are deleting rules which evaluate a large number of resource types, \n\t\t\t\tthis can lead to a spike in the number of CIs recorded.

\n

Best practice:

\n
    \n
  1. \n

    Stop recording AWS::Config::ResourceCompliance\n

    \n
    2. \n
  2. \n

    Delete rule(s)

    \n
    3. \n
  3. \n

    Turn on recording for AWS::Config::ResourceCompliance\n

    \n
    4. \n
\n " + "smithy.api#documentation": "

Deletes the specified Config rule and all of its evaluation\n\t\t\tresults.

\n

Config sets the state of a rule to DELETING\n\t\t\tuntil the deletion is complete. You cannot update a rule while it is\n\t\t\tin this state. If you make a PutConfigRule or\n\t\t\t\tDeleteConfigRule request for the rule, you will\n\t\t\treceive a ResourceInUseException.

\n

You can check the state of a rule by using the\n\t\t\t\tDescribeConfigRules request.

\n \n

\n Recommendation: Consider excluding the AWS::Config::ResourceCompliance resource type from recording before deleting rules\n

\n

Deleting rules creates configuration items (CIs) for AWS::Config::ResourceCompliance\n\t\t\t\tthat can affect your costs for the configuration recorder. If you are deleting rules which evaluate a large number of resource types,\n\t\t\t\tthis can lead to a spike in the number of CIs recorded.

\n

To avoid the associated costs, you can opt to disable recording \n\t\t\t\tfor the AWS::Config::ResourceCompliance resource type before deleting rules, and re-enable recording after the rules have been deleted.

\n

However, since deleting rules is an asynchronous process, it might take an hour or more to complete. During the time\n\t\t\t\twhen recording is disabled for AWS::Config::ResourceCompliance, rule evaluations will not be recorded in the associated resource’s history.

\n " } }, "com.amazonaws.configservice#DeleteConfigRuleRequest": { @@ -2983,7 +2983,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that \n\t\t\tconformance pack.

\n

Config sets the conformance pack to DELETE_IN_PROGRESS until the deletion is complete. \n\t\t\tYou cannot update a conformance pack while it is in this state.

" + "smithy.api#documentation": "

Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that \n\t\t\tconformance pack.

\n

Config sets the conformance pack to DELETE_IN_PROGRESS until the deletion is complete. \n\t\t\tYou cannot update a conformance pack while it is in this state.

\n \n

\n Recommendation: Consider excluding the AWS::Config::ResourceCompliance resource type from recording before deleting rules\n

\n

Deleting rules creates configuration items (CIs) for AWS::Config::ResourceCompliance\n\t\t\t\tthat can affect your costs for the configuration recorder. If you are deleting rules which evaluate a large number of resource types,\n\t\t\t\tthis can lead to a spike in the number of CIs recorded.

\n

To avoid the associated costs, you can opt to disable recording \n\t\t\t\tfor the AWS::Config::ResourceCompliance resource type before deleting rules, and re-enable recording after the rules have been deleted.

\n

However, since deleting rules is an asynchronous process, it might take an hour or more to complete. During the time\n\t\t\t\twhen recording is disabled for AWS::Config::ResourceCompliance, rule evaluations will not be recorded in the associated resource’s history.

\n " } }, "com.amazonaws.configservice#DeleteConformancePackRequest": { @@ -3101,7 +3101,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.

\n

Only a management account and a delegated administrator account can delete an organization Config rule.\n\t\tWhen calling this API with a delegated administrator, you must ensure Organizations \n\t\t\tListDelegatedAdministrator permissions are added.

\n

Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. \n\t\t\tYou cannot update a rule while it is in this state.

" + "smithy.api#documentation": "

Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.

\n

Only a management account and a delegated administrator account can delete an organization Config rule.\n\t\tWhen calling this API with a delegated administrator, you must ensure Organizations \n\t\t\tListDelegatedAdministrator permissions are added.

\n

Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. \n\t\t\tYou cannot update a rule while it is in this state.

\n \n

\n Recommendation: Consider excluding the AWS::Config::ResourceCompliance resource type from recording before deleting rules\n

\n

Deleting rules creates configuration items (CIs) for AWS::Config::ResourceCompliance\n\t\t\t\tthat can affect your costs for the configuration recorder. If you are deleting rules which evaluate a large number of resource types,\n\t\t\t\tthis can lead to a spike in the number of CIs recorded.

\n

To avoid the associated costs, you can opt to disable recording \n\t\t\t\tfor the AWS::Config::ResourceCompliance resource type before deleting rules, and re-enable recording after the rules have been deleted.

\n

However, since deleting rules is an asynchronous process, it might take an hour or more to complete. During the time\n\t\t\t\twhen recording is disabled for AWS::Config::ResourceCompliance, rule evaluations will not be recorded in the associated resource’s history.

\n " } }, "com.amazonaws.configservice#DeleteOrganizationConfigRuleRequest": { @@ -3139,7 +3139,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified organization conformance pack and all of the Config rules and remediation actions from\n\t\t\tall member accounts in that organization.

\n

Only a management account or a delegated administrator account can delete an organization conformance pack.\n\tWhen calling this API with a delegated administrator, you must ensure Organizations \n\t\tListDelegatedAdministrator permissions are added.

\n

Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. \n\t\t\t\tYou cannot update a conformance pack while it is in this state.

" + "smithy.api#documentation": "

Deletes the specified organization conformance pack and all of the Config rules and remediation actions from\n\t\t\tall member accounts in that organization.

\n

Only a management account or a delegated administrator account can delete an organization conformance pack.\n\tWhen calling this API with a delegated administrator, you must ensure Organizations \n\t\tListDelegatedAdministrator permissions are added.

\n

Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. \n\t\t\t\tYou cannot update a conformance pack while it is in this state.

\n \n

\n Recommendation: Consider excluding the AWS::Config::ResourceCompliance resource type from recording before deleting rules\n

\n

Deleting rules creates configuration items (CIs) for AWS::Config::ResourceCompliance\n\t\t\t\tthat can affect your costs for the configuration recorder. If you are deleting rules which evaluate a large number of resource types,\n\t\t\t\tthis can lead to a spike in the number of CIs recorded.

\n

To avoid the associated costs, you can opt to disable recording \n\t\t\t\tfor the AWS::Config::ResourceCompliance resource type before deleting rules, and re-enable recording after the rules have been deleted.

\n

However, since deleting rules is an asynchronous process, it might take an hour or more to complete. During the time\n\t\t\t\twhen recording is disabled for AWS::Config::ResourceCompliance, rule evaluations will not be recorded in the associated resource’s history.

\n " } }, "com.amazonaws.configservice#DeleteOrganizationConformancePackRequest": { @@ -4434,7 +4434,7 @@ "ConfigurationRecorderNames": { "target": "com.amazonaws.configservice#ConfigurationRecorderNameList", "traits": { - "smithy.api#documentation": "

The name of the configuration recorder. If the name is not\n\t\t\tspecified, the opertation returns the status for the customer managed configuration recorder configured for the\n\t\t\taccount, if applicable.

\n \n

When making a request to this operation, you can only specify one configuration recorder.

\n " + "smithy.api#documentation": "

The name of the configuration recorder. If the name is not\n\t\t\tspecified, the operation returns the status for the customer managed configuration recorder configured for the\n\t\t\taccount, if applicable.

\n \n

When making a request to this operation, you can only specify one configuration recorder.

\n " } }, "ServicePrincipal": { @@ -4509,7 +4509,7 @@ "ConfigurationRecorderNames": { "target": "com.amazonaws.configservice#ConfigurationRecorderNameList", "traits": { - "smithy.api#documentation": "

A list of names of the configuration recorders that you want to specify.

" + "smithy.api#documentation": "

A list of names of the configuration recorders that you want to specify.

\n \n

When making a request to this operation, you can only specify one configuration recorder.

\n " } }, "ServicePrincipal": { @@ -7380,7 +7380,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

For accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type.\n\t\t\tFor more information, see Selecting Which Resources Config Records.

\n \n

Returns a list of ConfigurationItems for the specified resource.\n\t\t\tThe list contains details about each state of the resource\n\t\t\tduring the specified time interval. If you specified a retention\n\t\t\tperiod to retain your ConfigurationItems between a\n\t\t\tminimum of 30 days and a maximum of 7 years (2557 days), Config\n\t\t\treturns the ConfigurationItems for the specified\n\t\t\tretention period.

\n

The response is paginated. By default, Config returns a\n\t\t\tlimit of 10 configuration items per page. You can customize this\n\t\t\tnumber with the limit parameter. The response includes\n\t\t\ta nextToken string. To get the next page of results,\n\t\t\trun the request again and specify the string for the\n\t\t\t\tnextToken parameter.

\n \n

Each call to the API is limited to span a duration of seven\n\t\t\t\tdays. It is likely that the number of records returned is\n\t\t\t\tsmaller than the specified limit. In such cases,\n\t\t\t\tyou can make another call, using the\n\t\t\t\tnextToken.

\n ", + "smithy.api#documentation": "\n

For accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type.

\n

For more information, see Recording Amazon Web Services Resources in the Config Resources Developer Guide.

\n \n

Returns a list of configurations items (CIs) for the specified resource.

\n

\n Contents\n

\n

The list contains details about each state of the resource\n\t\t\tduring the specified time interval. If you specified a retention\n\t\t\tperiod to retain your CIs between a\n\t\t\tminimum of 30 days and a maximum of 7 years (2557 days), Config\n\t\t\treturns the CIs for the specified\n\t\t\tretention period.

\n

\n Pagination\n

\n

The response is paginated. By default, Config returns a\n\t\t\tlimit of 10 configuration items per page. You can customize this\n\t\t\tnumber with the limit parameter. The response includes\n\t\t\ta nextToken string. To get the next page of results,\n\t\t\trun the request again and specify the string for the\n\t\t\t\tnextToken parameter.

\n \n

Each call to the API is limited to span a duration of seven\n\t\t\t\tdays. It is likely that the number of records returned is\n\t\t\t\tsmaller than the specified limit. In such cases,\n\t\t\t\tyou can make another call, using the\n\t\t\t\tnextToken.

\n ", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -7449,7 +7449,7 @@ "configurationItems": { "target": "com.amazonaws.configservice#ConfigurationItemList", "traits": { - "smithy.api#documentation": "

A list that contains the configuration history of one or more\n\t\t\tresources.

" + "smithy.api#documentation": "

An array of ConfigurationItems Objects. Contatins the configuration history for one or more\n\t\t\tresources.

" } }, "nextToken": { @@ -7700,7 +7700,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have provided a name for the customer managed configuration recorder that is not\n\t\t\tvalid.

", + "smithy.api#documentation": "

The configuration recorder name is not valid. The prefix \"AWSConfigurationRecorderFor\" is reserved for service-linked configuration recorders.

", "smithy.api#error": "client" } }, @@ -8205,7 +8205,7 @@ } ], "traits": { - "smithy.api#documentation": "

Accepts a resource type and returns a list of resource\n\t\t\tidentifiers for the resources of that type. A resource identifier\n\t\t\tincludes the resource type, ID, and (if available) the custom\n\t\t\tresource name. The results consist of resources that Config has\n\t\t\tdiscovered, including those that Config is not currently\n\t\t\trecording. You can narrow the results to include only resources that\n\t\t\thave specific resource IDs or a resource name.

\n \n

You can specify either resource IDs or a resource name, but\n\t\t\t\tnot both, in the same request.

\n \n

The response is paginated. By default, Config lists 100\n\t\t\tresource identifiers on each page. You can customize this number\n\t\t\twith the limit parameter. The response includes a\n\t\t\t\tnextToken string. To get the next page of results,\n\t\t\trun the request again and specify the string for the\n\t\t\t\tnextToken parameter.

", + "smithy.api#documentation": "

Returns a list of resource\n\t\t\tresource identifiers for the specified resource types for the resources of that type. A resource identifier\n\t\t\tincludes the resource type, ID, and (if available) the custom\n\t\t\tresource name.

\n

The results consist of resources that Config has\n\t\t\tdiscovered, including those that Config is not currently\n\t\t\trecording. You can narrow the results to include only resources that\n\t\t\thave specific resource IDs or a resource name.

\n \n

You can specify either resource IDs or a resource name, but\n\t\t\t\tnot both, in the same request.

\n \n \n

\n CloudFormation stack recording behavior in Config\n

\n

When a CloudFormation stack fails to create (for example, it enters the ROLLBACK_FAILED state), \n\t\t\t\tConfig does not record a configuration item (CI) for that stack. Configuration items are only recorded for stacks that reach \n\t\t\t\tthe following states:

\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 UPDATE_ROLLBACK_FAILED\n

    \n
    • \n
  • \n

    \n DELETE_FAILED\n

    \n
    • \n
  • \n

    \n DELETE_COMPLETE\n

    \n
    • \n
\n

Because no CI is created for a failed stack creation, you won't see configuration history \n\t\t\t\tfor that stack in Config, even after the stack is deleted. This helps make sure that Config only \n\t\t\t\ttracks resources that were successfully provisioned.

\n ", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -10363,7 +10363,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization.\n\t\t\tFor information on how many conformance packs you can have per account, \n\t\t\tsee \n Service Limits\n in the Config Developer Guide.

\n

This API creates a service-linked role AWSServiceRoleForConfigConforms in your account. \n\t\tThe service-linked role is created only when the role does not exist in your account.

\n \n

You must specify only one of the follow parameters: TemplateS3Uri, TemplateBody or TemplateSSMDocumentDetails.

\n " + "smithy.api#documentation": "

Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization.\n\t\t\tFor information on how many conformance packs you can have per account, \n\t\t\tsee \n Service Limits\n in the Config Developer Guide.

\n \n

When you use PutConformancePack to deploy conformance packs in your account,\n\t\t\t\tthe operation can create Config rules and remediation actions without\n\t\t\t\trequiring config:PutConfigRule or\n\t\t\t\t\tconfig:PutRemediationConfigurations permissions in your account IAM\n\t\t\t\tpolicies.

\n

This API uses the AWSServiceRoleForConfigConforms service-linked role in your\n\t\t\t\taccount to create conformance pack resources. This service-linked role includes the\n\t\t\t\tpermissions to create Config rules and remediation configurations, even\n\t\t\t\tif your account IAM policies explicitly deny these actions.

\n \n

This API creates a service-linked role AWSServiceRoleForConfigConforms in your account. \n\t\tThe service-linked role is created only when the role does not exist in your account.

\n \n

You must specify only one of the follow parameters: TemplateS3Uri, TemplateBody or TemplateSSMDocumentDetails.

\n " } }, "com.amazonaws.configservice#PutConformancePackRequest": { @@ -10385,7 +10385,7 @@ "TemplateBody": { "target": "com.amazonaws.configservice#TemplateBody", "traits": { - "smithy.api#documentation": "

A string containing the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.

\n \n

You can use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).

\n " + "smithy.api#documentation": "

A string that contains the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.

\n \n

You can use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).

\n " } }, "DeliveryS3Bucket": { @@ -10727,7 +10727,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, \n\t\t\tsee \n Service Limits\n in the Config Developer Guide.

\n

Only a management account and a delegated administrator can call this API. \n\t\t\tWhen calling this API with a delegated administrator, you must ensure Organizations \n\t\t\tListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators.

\n

This API enables organization service access for config-multiaccountsetup.amazonaws.com\n\t\t\tthrough the EnableAWSServiceAccess action and creates a \n\t\t\tservice-linked role AWSServiceRoleForConfigMultiAccountSetup in the management or delegated administrator account of your organization. \n\t\t\tThe service-linked role is created only when the role does not exist in the caller account. \n\t\t\tTo use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization \n\t\t\tregister-delegate-admin for config-multiaccountsetup.amazonaws.com.

\n \n

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

\n

You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. \n\t\t\tIf you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

\n

Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. \n\t\t\t\tYou cannot update a conformance pack while it is in this state.

\n " + "smithy.api#documentation": "

Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, \n\t\t\tsee \n Service Limits\n in the Config Developer Guide.

\n

Only a management account and a delegated administrator can call this API. \n\t\t\tWhen calling this API with a delegated administrator, you must ensure Organizations \n\t\t\tListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators.

\n \n

When you use PutOrganizationConformancePack to deploy conformance packs across\n\t\t\t\tmember accounts, the operation can create Config rules and remediation\n\t\t\t\tactions without requiring config:PutConfigRule or\n\t\t\t\t\tconfig:PutRemediationConfigurations permissions in member account\n\t\t\t\tIAM policies.

\n

This API uses the AWSServiceRoleForConfigConforms service-linked role in each\n\t\t\t\tmember account to create conformance pack resources. This service-linked role\n\t\t\t\tincludes the permissions to create Config rules and remediation\n\t\t\t\tconfigurations, even if member account IAM policies explicitly deny these\n\t\t\t\tactions.

\n \n

This API enables organization service access for config-multiaccountsetup.amazonaws.com\n\t\t\tthrough the EnableAWSServiceAccess action and creates a \n\t\t\tservice-linked role AWSServiceRoleForConfigMultiAccountSetup in the management or delegated administrator account of your organization. \n\t\t\tThe service-linked role is created only when the role does not exist in the caller account. \n\t\t\tTo use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization \n\t\t\tregister-delegate-admin for config-multiaccountsetup.amazonaws.com.

\n \n

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

\n

You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. \n\t\t\tIf you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

\n

Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. \n\t\t\t\tYou cannot update a conformance pack while it is in this state.

\n " } }, "com.amazonaws.configservice#PutOrganizationConformancePackRequest": { @@ -10749,7 +10749,7 @@ "TemplateBody": { "target": "com.amazonaws.configservice#TemplateBody", "traits": { - "smithy.api#documentation": "

A string containing full conformance pack template body. Structure containing the template body\n\t\t\twith a minimum length of 1 byte and a maximum length of 51,200 bytes.

" + "smithy.api#documentation": "

A string that contains the full conformance pack template body. Structure containing the template body\n\t\t\twith a minimum length of 1 byte and a maximum length of 51,200 bytes.

" } }, "DeliveryS3Bucket": { @@ -11058,7 +11058,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a service-linked configuration recorder that is linked to a specific Amazon Web Services service based on the ServicePrincipal you specify.

\n

The configuration recorder's name, recordingGroup, recordingMode, and recordingScope is set by the service that is linked to the configuration recorder.

\n

For more information, see \n Working with the Configuration Recorder\n in the Config Developer Guide.

\n

This API creates a service-linked role AWSServiceRoleForConfig in your account. The service-linked role is created only when the role does not exist in your account.

\n \n

\n The recording scope determines if you receive configuration items\n

\n

The recording scope is set by the service that is linked to the configuration recorder and determines whether you receive configuration items (CIs) in the delivery channel. If the recording scope is internal, you will not receive CIs in the delivery channel.

\n

\n Tags are added at creation and cannot be updated with this operation\n

\n

Use TagResource and UntagResource to update tags after creation.

\n " + "smithy.api#documentation": "

Creates a service-linked configuration recorder that is linked to a specific Amazon Web Services service based on the ServicePrincipal you specify.

\n

The configuration recorder's name, recordingGroup, recordingMode, and recordingScope is set by the service that is linked to the configuration recorder.

\n

For more information and a list of supported services/service principals, see \n Working with the Configuration Recorder\n in the Config Developer Guide.

\n

This API creates a service-linked role AWSServiceRoleForConfig in your account. The service-linked role is created only when the role does not exist in your account.

\n \n

\n The recording scope determines if you receive configuration items\n

\n

The recording scope is set by the service that is linked to the configuration recorder and determines whether you receive configuration items (CIs) in the delivery channel. If the recording scope is internal, you will not receive CIs in the delivery channel.

\n

\n Tags are added at creation and cannot be updated with this operation\n

\n

Use TagResource and UntagResource to update tags after creation.

\n " } }, "com.amazonaws.configservice#PutServiceLinkedConfigurationRecorderRequest": { @@ -11094,7 +11094,7 @@ "Name": { "target": "com.amazonaws.configservice#RecorderName", "traits": { - "smithy.api#documentation": "

The name of the specified configuration recorder.

\n

For service-linked configuration recorders, Config automatically assigns a name that has the prefix \"AWS\" to the new service-linked configuration recorder.

" + "smithy.api#documentation": "

The name of the specified configuration recorder.

\n

For service-linked configuration recorders, Config automatically assigns a name that has the prefix \"AWSConfigurationRecorderFor\" to the new service-linked configuration recorder.

" } } }, @@ -17025,7 +17025,7 @@ "EvaluationMode": { "target": "com.amazonaws.configservice#EvaluationMode", "traits": { - "smithy.api#documentation": "

The mode of an evaluation. The valid values for this API are DETECTIVE and PROACTIVE.

", + "smithy.api#documentation": "

The mode of an evaluation.

\n \n

The only valid value for this API is PROACTIVE.

\n ", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/customer-profiles.json b/codegen/sdk/aws-models/customer-profiles.json index 4011bda41bb..b3f8d88f1fe 100644 --- a/codegen/sdk/aws-models/customer-profiles.json +++ b/codegen/sdk/aws-models/customer-profiles.json @@ -1405,6 +1405,85 @@ "smithy.api#documentation": "

The matching criteria to be used during the auto-merging process.

" } }, + "com.amazonaws.customerprofiles#ContactPreference": { + "type": "structure", + "members": { + "KeyName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "

A searchable, unique identifier of a customer profile.

" + } + }, + "KeyValue": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "

The key value used to look up profile based off the keyName.

" + } + }, + "ProfileId": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

The unique identifier of a customer profile.

" + } + }, + "ContactType": { + "target": "com.amazonaws.customerprofiles#ContactType", + "traits": { + "smithy.api#documentation": "

The contact type used for engagement. For example: HomePhoneNumber,\n PersonalEmailAddress.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Object that defines users contact preference.

" + } + }, + "com.amazonaws.customerprofiles#ContactType": { + "type": "enum", + "members": { + "PHONE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PhoneNumber" + } + }, + "MOBILE_PHONE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MobilePhoneNumber" + } + }, + "HOME_PHONE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HomePhoneNumber" + } + }, + "BUSINESS_PHONE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BusinessPhoneNumber" + } + }, + "EMAIL_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EmailAddress" + } + }, + "PERSONAL_EMAIL_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PersonalEmailAddress" + } + }, + "BUSINESS_EMAIL_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BusinessEmailAddress" + } + } + } + }, "com.amazonaws.customerprofiles#CreateCalculatedAttributeDefinition": { "type": "operation", "input": { @@ -2465,6 +2544,18 @@ "traits": { "smithy.api#documentation": "

An alternative to Gender which accepts any string as input.

" } + }, + "ProfileType": { + "target": "com.amazonaws.customerprofiles#ProfileType", + "traits": { + "smithy.api#documentation": "

The type of the profile.

" + } + }, + "EngagementPreferences": { + "target": "com.amazonaws.customerprofiles#EngagementPreferences", + "traits": { + "smithy.api#documentation": "

Object that defines the preferred methods of engagement, per channel.

" + } } }, "traits": { @@ -5142,12 +5233,39 @@ } } }, + "com.amazonaws.customerprofiles#EmailPreferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#ContactPreference" + } + }, "com.amazonaws.customerprofiles#End": { "type": "integer", "traits": { "smithy.api#default": 0 } }, + "com.amazonaws.customerprofiles#EngagementPreferences": { + "type": "structure", + "members": { + "Phone": { + "target": "com.amazonaws.customerprofiles#PhonePreferenceList", + "traits": { + "smithy.api#documentation": "

A list of phone-related contact preferences

" + } + }, + "Email": { + "target": "com.amazonaws.customerprofiles#EmailPreferenceList", + "traits": { + "smithy.api#documentation": "

A list of email-related contact preferences

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Object that defines users preferred methods of engagement.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.customerprofiles#EstimateStatus": { "type": "enum", "members": { @@ -5732,6 +5850,18 @@ "traits": { "smithy.api#documentation": "

A unique identifier for the attributes field to be merged.

" } + }, + "ProfileType": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

A unique identifier for the profile type field to be merged.

" + } + }, + "EngagementPreferences": { + "target": "com.amazonaws.customerprofiles#uuid", + "traits": { + "smithy.api#documentation": "

A unique identifier for the engagement preferences field to be merged.

" + } } }, "traits": { @@ -11795,6 +11925,12 @@ } } }, + "com.amazonaws.customerprofiles#PhonePreferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#ContactPreference" + } + }, "com.amazonaws.customerprofiles#Profile": { "type": "structure", "members": { @@ -11947,6 +12083,18 @@ "traits": { "smithy.api#documentation": "

An alternative to Gender which accepts any string as input.

" } + }, + "ProfileType": { + "target": "com.amazonaws.customerprofiles#ProfileType", + "traits": { + "smithy.api#documentation": "

The type of the profile.

" + } + }, + "EngagementPreferences": { + "target": "com.amazonaws.customerprofiles#EngagementPreferences", + "traits": { + "smithy.api#documentation": "

The customer or account’s engagement preferences.

" + } } }, "traits": { @@ -12160,6 +12308,13 @@ "smithy.api#documentation": "

A field to describe values to segment on within attributes.

", "smithy.api#jsonName": "Attributes" } + }, + "ProfileType": { + "target": "com.amazonaws.customerprofiles#ProfileTypeDimension", + "traits": { + "smithy.api#documentation": "

A field to describe values to segment on within profile type.

", + "smithy.api#jsonName": "ProfileType" + } } }, "traits": { @@ -12312,6 +12467,79 @@ "smithy.api#documentation": "

Object that holds the results for membership.

" } }, + "com.amazonaws.customerprofiles#ProfileType": { + "type": "enum", + "members": { + "ACCOUNT_PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_PROFILE" + } + }, + "PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFILE" + } + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.customerprofiles#ProfileTypeDimension": { + "type": "structure", + "members": { + "DimensionType": { + "target": "com.amazonaws.customerprofiles#ProfileTypeDimensionType", + "traits": { + "smithy.api#documentation": "

The action to segment on.

", + "smithy.api#jsonName": "DimensionType", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.customerprofiles#ProfileTypeValues", + "traits": { + "smithy.api#documentation": "

The values to apply the DimensionType on.

", + "smithy.api#jsonName": "Values", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Object to hold the dimension of a profile type field to segment on.

" + } + }, + "com.amazonaws.customerprofiles#ProfileTypeDimensionType": { + "type": "enum", + "members": { + "INCLUSIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUSIVE" + } + }, + "EXCLUSIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCLUSIVE" + } + } + } + }, + "com.amazonaws.customerprofiles#ProfileTypeValues": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#ProfileType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.customerprofiles#Profiles": { "type": "list", "member": { @@ -15776,6 +16004,18 @@ "traits": { "smithy.api#documentation": "

An alternative to Gender which accepts any string as input.

" } + }, + "ProfileType": { + "target": "com.amazonaws.customerprofiles#ProfileType", + "traits": { + "smithy.api#documentation": "

Determines the type of the profile.

" + } + }, + "EngagementPreferences": { + "target": "com.amazonaws.customerprofiles#EngagementPreferences", + "traits": { + "smithy.api#documentation": "

Object that defines users preferred methods of engagement.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/datazone.json b/codegen/sdk/aws-models/datazone.json index feb46d33402..7df080057ac 100644 --- a/codegen/sdk/aws-models/datazone.json +++ b/codegen/sdk/aws-models/datazone.json @@ -655,6 +655,118 @@ "smithy.api#documentation": "

The details of the policy grant.

" } }, + "com.amazonaws.datazone#AggregationAttributeDisplayValue": { + "type": "string" + }, + "com.amazonaws.datazone#AggregationAttributeValue": { + "type": "string" + }, + "com.amazonaws.datazone#AggregationDisplayValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.datazone#AggregationList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AggregationListItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.datazone#AggregationListItem": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.datazone#Attribute", + "traits": { + "smithy.api#documentation": "

An attribute on which to compute aggregations.

", + "smithy.api#required": {} + } + }, + "displayValue": { + "target": "com.amazonaws.datazone#AggregationDisplayValue", + "traits": { + "smithy.api#documentation": "

The display value of the aggregation list item. Supported values include\n value and glossaryTerm.name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An aggregation list item.

" + } + }, + "com.amazonaws.datazone#AggregationOutput": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.datazone#Attribute", + "traits": { + "smithy.api#documentation": "

The attribute for this aggregation.

" + } + }, + "displayValue": { + "target": "com.amazonaws.datazone#AggregationDisplayValue", + "traits": { + "smithy.api#documentation": "

The display value of the aggregation output item.

" + } + }, + "items": { + "target": "com.amazonaws.datazone#AggregationOutputItems", + "traits": { + "smithy.api#documentation": "

A list of aggregation output items.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregation for an attribute.

" + } + }, + "com.amazonaws.datazone#AggregationOutputItem": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.datazone#AggregationAttributeValue", + "traits": { + "smithy.api#documentation": "

The attribute value of the aggregation output item.

" + } + }, + "count": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The count of the aggregation output item.

" + } + }, + "displayValue": { + "target": "com.amazonaws.datazone#AggregationAttributeDisplayValue", + "traits": { + "smithy.api#documentation": "

The display value of the aggregation. If the attribute being aggregated corresponds to\n the id of a public resource, the service automatically resolves the id to the provided\n display value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An aggregation output item.

" + } + }, + "com.amazonaws.datazone#AggregationOutputItems": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AggregationOutputItem" + } + }, + "com.amazonaws.datazone#AggregationOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AggregationOutput" + } + }, "com.amazonaws.datazone#AllDomainUnitsGrantFilter": { "type": "structure", "members": {}, @@ -1027,6 +1139,12 @@ "traits": { "smithy.api#documentation": "

The latest time series data points forms included in the additional attributes of an\n asset.

" } + }, + "matchRationale": { + "target": "com.amazonaws.datazone#MatchRationale", + "traits": { + "smithy.api#documentation": "

List of rationales indicating why this item was matched by search.

" + } } }, "traits": { @@ -1206,6 +1324,12 @@ "smithy.api#documentation": "

The metadata forms that form additional attributes of the metadata asset.

" } }, + "matchRationale": { + "target": "com.amazonaws.datazone#MatchRationale", + "traits": { + "smithy.api#documentation": "

List of rationales indicating why this item was matched by search.

" + } + }, "latestTimeSeriesDataPointForms": { "target": "com.amazonaws.datazone#TimeSeriesDataPointSummaryFormOutputList", "traits": { @@ -3058,7 +3182,7 @@ "externalIdentifier": { "target": "com.amazonaws.datazone#ExternalIdentifier", "traits": { - "smithy.api#documentation": "

The external identifier of the asset.

" + "smithy.api#documentation": "

The external identifier of the asset.

\n

If the value for the externalIdentifier parameter is specified, it must be\n a unique value.

" } }, "typeIdentifier": { @@ -7793,6 +7917,20 @@ "smithy.api#documentation": "

The data product.

" } }, + "com.amazonaws.datazone#DataProductItemAdditionalAttributes": { + "type": "structure", + "members": { + "matchRationale": { + "target": "com.amazonaws.datazone#MatchRationale", + "traits": { + "smithy.api#documentation": "

List of rationales indicating why this item was matched by search.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The additional attributes of an Amazon DataZone data product.

" + } + }, "com.amazonaws.datazone#DataProductItemType": { "type": "enum", "members": { @@ -7959,6 +8097,12 @@ "traits": { "smithy.api#documentation": "

The metadata forms of the asset of the data product.

" } + }, + "matchRationale": { + "target": "com.amazonaws.datazone#MatchRationale", + "traits": { + "smithy.api#documentation": "

List of rationales indicating why this item was matched by search.

" + } } }, "traits": { @@ -8041,6 +8185,12 @@ "traits": { "smithy.api#documentation": "

The user who created the first revision of the data product.

" } + }, + "additionalAttributes": { + "target": "com.amazonaws.datazone#DataProductItemAdditionalAttributes", + "traits": { + "smithy.api#documentation": "

The additional attributes of an Amazon DataZone data product.

" + } } }, "traits": { @@ -14074,7 +14224,7 @@ "identifier": { "target": "com.amazonaws.datazone#AssetIdentifier", "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone asset.

", + "smithy.api#documentation": "

The ID of the Amazon DataZone asset.

\n

This parameter supports either the value of assetId or externalIdentifier\n as input. If you are passing the value of externalIdentifier, you must prefix this\n value with externalIdentifer%2F.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18912,12 +19062,32 @@ "traits": { "smithy.api#documentation": "

The Amazon DataZone user who updated the business glossary.

" } + }, + "additionalAttributes": { + "target": "com.amazonaws.datazone#GlossaryItemAdditionalAttributes", + "traits": { + "smithy.api#documentation": "

The additional attributes of an Amazon DataZone glossary.

" + } } }, "traits": { "smithy.api#documentation": "

The details of a business glossary.

" } }, + "com.amazonaws.datazone#GlossaryItemAdditionalAttributes": { + "type": "structure", + "members": { + "matchRationale": { + "target": "com.amazonaws.datazone#MatchRationale", + "traits": { + "smithy.api#documentation": "

List of rationales indicating why this item was matched by search.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The additional attributes of an Amazon DataZone glossary.

" + } + }, "com.amazonaws.datazone#GlossaryName": { "type": "string", "traits": { @@ -19094,12 +19264,32 @@ "traits": { "smithy.api#documentation": "

The Amazon DataZone user who updated the business glossary term.

" } + }, + "additionalAttributes": { + "target": "com.amazonaws.datazone#GlossaryTermItemAdditionalAttributes", + "traits": { + "smithy.api#documentation": "

The additional attributes of an Amazon DataZone glossary term.

" + } } }, "traits": { "smithy.api#documentation": "

The details of a business glossary term.

" } }, + "com.amazonaws.datazone#GlossaryTermItemAdditionalAttributes": { + "type": "structure", + "members": { + "matchRationale": { + "target": "com.amazonaws.datazone#MatchRationale", + "traits": { + "smithy.api#documentation": "

List of rationales indicating why this item was matched by search.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The additional attributes of an Amazon DataZone glossary term.

" + } + }, "com.amazonaws.datazone#GlossaryTermName": { "type": "string", "traits": { @@ -24795,6 +24985,52 @@ } } }, + "com.amazonaws.datazone#MatchOffset": { + "type": "structure", + "members": { + "startOffset": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The 0-indexed number indicating the start position (inclusive) of a matched term.

" + } + }, + "endOffset": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The 0-indexed number indicating the end position (exclusive) of a matched term.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The offset of a matched term.

" + } + }, + "com.amazonaws.datazone#MatchOffsets": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#MatchOffset" + } + }, + "com.amazonaws.datazone#MatchRationale": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#MatchRationaleItem" + } + }, + "com.amazonaws.datazone#MatchRationaleItem": { + "type": "union", + "members": { + "textMatches": { + "target": "com.amazonaws.datazone#TextMatches", + "traits": { + "smithy.api#documentation": "

A list of TextMatchItems.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rationale indicating why this item was matched by search.

" + } + }, "com.amazonaws.datazone#MaxResults": { "type": "integer", "traits": { @@ -28806,7 +29042,7 @@ "s3AccessGrantLocationId": { "target": "com.amazonaws.datazone#S3AccessGrantLocationId", "traits": { - "smithy.api#documentation": "

The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection.

" + "smithy.api#documentation": "

The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a\n connection.

" } } }, @@ -28827,7 +29063,7 @@ "s3AccessGrantLocationId": { "target": "com.amazonaws.datazone#S3AccessGrantLocationId", "traits": { - "smithy.api#documentation": "

The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection.

" + "smithy.api#documentation": "

The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a\n connection.

" } }, "status": { @@ -28860,7 +29096,7 @@ "s3AccessGrantLocationId": { "target": "com.amazonaws.datazone#S3AccessGrantLocationId", "traits": { - "smithy.api#documentation": "

The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties patch of a connection.

" + "smithy.api#documentation": "

The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties patch of\n a connection.

" } } }, @@ -29290,7 +29526,10 @@ "searchText": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the text for which to search.

" + "smithy.api#documentation": "

Specifies the text for which to search.

", + "smithy.api#length": { + "max": 512 + } } }, "searchIn": { @@ -29317,6 +29556,12 @@ "smithy.api#documentation": "

Specifies the filters for the search of listings.

" } }, + "aggregations": { + "target": "com.amazonaws.datazone#AggregationList", + "traits": { + "smithy.api#documentation": "

Enables you to specify one or more attributes to compute and return counts grouped by\n field values.

" + } + }, "sort": { "target": "com.amazonaws.datazone#SearchSort", "traits": { @@ -29354,6 +29599,12 @@ "traits": { "smithy.api#documentation": "

Total number of search results.

" } + }, + "aggregates": { + "target": "com.amazonaws.datazone#AggregationOutputList", + "traits": { + "smithy.api#documentation": "

Contains computed counts grouped by field values based on the requested aggregation\n attributes for the matching listings.

" + } } }, "traits": { @@ -29400,6 +29651,12 @@ "traits": { "smithy.api#enumValue": "TIME_SERIES_DATA_POINT_FORMS" } + }, + "TEXT_MATCH_RATIONALE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_MATCH_RATIONALE" + } } } }, @@ -29464,7 +29721,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 4096 + "max": 512 } } }, @@ -31837,6 +32094,38 @@ "smithy.api#documentation": "

The details of the term relations.

" } }, + "com.amazonaws.datazone#TextMatchItem": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.datazone#Attribute", + "traits": { + "smithy.api#documentation": "

The name of the attribute.

" + } + }, + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Snippet of attribute text containing highlighted content.

" + } + }, + "matchOffsets": { + "target": "com.amazonaws.datazone#MatchOffsets", + "traits": { + "smithy.api#documentation": "

List of offsets indicating matching terms in the TextMatchItem text.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure indicating matched terms for an attribute.

" + } + }, + "com.amazonaws.datazone#TextMatches": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#TextMatchItem" + } + }, "com.amazonaws.datazone#ThrottlingException": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/deadline.json b/codegen/sdk/aws-models/deadline.json index f6e63c0d2c2..bcc73eaa40f 100644 --- a/codegen/sdk/aws-models/deadline.json +++ b/codegen/sdk/aws-models/deadline.json @@ -2467,7 +2467,10 @@ "deadline:TagResource", "iam:PassRole", "identitystore:ListGroupMembershipsForMember", - "logs:CreateLogGroup" + "logs:CreateLogGroup", + "vpc-lattice:GetResourceConfiguration", + "vpc-lattice:GetResourceGateway", + "ec2:CreateVpcEndpoint" ] }, "smithy.api#documentation": "

Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.

", @@ -3028,6 +3031,7 @@ "name": "CreateMonitor", "documentation": "Grants permission to create a monitor", "requiredActions": [ + "deadline:TagResource", "sso:CreateApplication", "sso:PutApplicationAssignmentConfiguration", "sso:PutApplicationAuthenticationMethod", @@ -3086,6 +3090,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.

", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.deadline#Tags", + "traits": { + "smithy.api#documentation": "

The tags to add to your monitor. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

" + } } }, "traits": { @@ -11595,6 +11605,18 @@ "smithy.api#documentation": "

The date and time the resource started running.

" } }, + "updatedAt": { + "target": "com.amazonaws.deadline#UpdatedAt", + "traits": { + "smithy.api#documentation": "

The date and time the resource was updated.

" + } + }, + "updatedBy": { + "target": "com.amazonaws.deadline#UpdatedBy", + "traits": { + "smithy.api#documentation": "

The user or system that updated this resource.

" + } + }, "jobParameters": { "target": "com.amazonaws.deadline#JobParameters", "traits": { @@ -17645,6 +17667,12 @@ "smithy.api#required": {} } }, + "vpcConfiguration": { + "target": "com.amazonaws.deadline#VpcConfiguration", + "traits": { + "smithy.api#documentation": "

The VPC configuration details for a service managed Amazon EC2 fleet.

" + } + }, "storageProfileId": { "target": "com.amazonaws.deadline#StorageProfileId", "traits": { @@ -19020,6 +19048,12 @@ "smithy.api#documentation": "

The date and time the resource was created.

" } }, + "createdBy": { + "target": "com.amazonaws.deadline#CreatedBy", + "traits": { + "smithy.api#documentation": "

The user or system that created this resource.

" + } + }, "startedAt": { "target": "com.amazonaws.deadline#StartedAt", "traits": { @@ -19032,6 +19066,18 @@ "smithy.api#documentation": "

The date and time the resource ended running.

" } }, + "updatedAt": { + "target": "com.amazonaws.deadline#UpdatedAt", + "traits": { + "smithy.api#documentation": "

The date and time the resource was updated.

" + } + }, + "updatedBy": { + "target": "com.amazonaws.deadline#UpdatedBy", + "traits": { + "smithy.api#documentation": "

The user or system that updated this resource.

" + } + }, "parameterSpace": { "target": "com.amazonaws.deadline#ParameterSpace", "traits": { @@ -19869,6 +19915,18 @@ "traits": { "smithy.api#documentation": "

The date and time the resource ended running.

" } + }, + "updatedAt": { + "target": "com.amazonaws.deadline#UpdatedAt", + "traits": { + "smithy.api#documentation": "

The date and time the resource was updated.

" + } + }, + "updatedBy": { + "target": "com.amazonaws.deadline#UpdatedBy", + "traits": { + "smithy.api#documentation": "

The user or system that updated this resource.

" + } } }, "traits": { @@ -20456,7 +20514,10 @@ "documentation": "Grants permission to update a fleet", "requiredActions": [ "identitystore:ListGroupMembershipsForMember", - "iam:PassRole" + "iam:PassRole", + "vpc-lattice:GetResourceConfiguration", + "vpc-lattice:GetResourceGateway", + "ec2:CreateVpcEndpoint" ] }, "smithy.api#documentation": "

Updates a fleet.

", @@ -22458,6 +22519,20 @@ } } }, + "com.amazonaws.deadline#VpcConfiguration": { + "type": "structure", + "members": { + "resourceConfigurationArns": { + "target": "com.amazonaws.deadline#VpcResourceConfigurationArns", + "traits": { + "smithy.api#documentation": "

The ARNs of the VPC Lattice resource configurations attached to the fleet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration options for a service managed fleet's VPC.

" + } + }, "com.amazonaws.deadline#VpcId": { "type": "string", "traits": { @@ -22468,6 +22543,21 @@ "smithy.api#pattern": "^vpc-[\\w]{1,120}$" } }, + "com.amazonaws.deadline#VpcResourceConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.deadline#VpcResourceConfigurationArns": { + "type": "list", + "member": { + "target": "com.amazonaws.deadline#VpcResourceConfigurationArn" + } + }, "com.amazonaws.deadline#WindowsUser": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/direct-connect.json b/codegen/sdk/aws-models/direct-connect.json index d2493a3cc9e..9facc50c825 100644 --- a/codegen/sdk/aws-models/direct-connect.json +++ b/codegen/sdk/aws-models/direct-connect.json @@ -560,7 +560,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.

\n

You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request.

\n

For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide.

" + "smithy.api#documentation": "

Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with a Direct Connect connection.

\n

You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request.

\n

For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide.

" } }, "com.amazonaws.directconnect#AssociateMacSecKeyRequest": { @@ -569,26 +569,26 @@ "connectionId": { "target": "com.amazonaws.directconnect#ConnectionId", "traits": { - "smithy.api#documentation": "

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

\n

You can use DescribeConnections or DescribeLags to retrieve connection ID.

", + "smithy.api#documentation": "

The ID of the dedicated connection (dxcon-xxxx), interconnect (dxcon-xxxx), or LAG (dxlag-xxxx).

\n

You can use DescribeConnections, DescribeInterconnects, or DescribeLags to retrieve connection ID.

", "smithy.api#required": {} } }, "secretARN": { "target": "com.amazonaws.directconnect#SecretARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.

\n

You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.

\n

If you use this request parameter, you do not use the ckn and cak request parameters.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the connection.

\n

You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.

\n

If you use this request parameter, you do not use the ckn and cak request parameters.

" } }, "ckn": { "target": "com.amazonaws.directconnect#Ckn", "traits": { - "smithy.api#documentation": "

The MAC Security (MACsec) CKN to associate with the dedicated connection.

\n

You can create the CKN/CAK pair using an industry standard tool.

\n

The valid values are 64 hexadecimal characters (0-9, A-E).

\n

If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.

" + "smithy.api#documentation": "

The MAC Security (MACsec) CKN to associate with the connection.

\n

You can create the CKN/CAK pair using an industry standard tool.

\n

The valid values are 64 hexadecimal characters (0-9, A-E).

\n

If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.

" } }, "cak": { "target": "com.amazonaws.directconnect#Cak", "traits": { - "smithy.api#documentation": "

The MAC Security (MACsec) CAK to associate with the dedicated connection.

\n

You can create the CKN/CAK pair using an industry standard tool.

\n

The valid values are 64 hexadecimal characters (0-9, A-E).

\n

If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.

" + "smithy.api#documentation": "

The MAC Security (MACsec) CAK to associate with the connection.

\n

You can create the CKN/CAK pair using an industry standard tool.

\n

The valid values are 64 hexadecimal characters (0-9, A-E).

\n

If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.

" } } }, @@ -602,13 +602,13 @@ "connectionId": { "target": "com.amazonaws.directconnect#ConnectionId", "traits": { - "smithy.api#documentation": "

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

" + "smithy.api#documentation": "

The ID of the dedicated connection (dxcon-xxxx), interconnect (dxcon-xxxx), or LAG (dxlag-xxxx).

" } }, "macSecKeys": { "target": "com.amazonaws.directconnect#MacSecKeyList", "traits": { - "smithy.api#documentation": "

The MAC Security (MACsec) security keys associated with the dedicated connection.

" + "smithy.api#documentation": "

The MAC Security (MACsec) security keys associated with the connection.

" } } }, @@ -1304,6 +1304,12 @@ "traits": { "smithy.api#documentation": "

The MAC Security (MACsec) security keys associated with the connection.

" } + }, + "partnerInterconnectMacSecCapable": { + "target": "com.amazonaws.directconnect#PartnerInterconnectMacSecCapable", + "traits": { + "smithy.api#documentation": "

Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).

" + } } }, "traits": { @@ -1543,7 +1549,7 @@ "requestMACSec": { "target": "com.amazonaws.directconnect#RequestMACSec", "traits": { - "smithy.api#documentation": "

Indicates whether you want the connection to support MAC Security (MACsec).

\n

MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

" + "smithy.api#documentation": "

Indicates whether you want the connection to support MAC Security (MACsec).

\n

MAC Security (MACsec) is unavailable on hosted connections. For information about MAC Security (MACsec) prerequisites, see MAC Security in Direct Connect in the Direct Connect User Guide.

" } } }, @@ -1821,6 +1827,12 @@ "traits": { "smithy.api#documentation": "

The name of the service provider associated with the interconnect.

" } + }, + "requestMACSec": { + "target": "com.amazonaws.directconnect#RequestMACSec", + "traits": { + "smithy.api#documentation": "

Indicates whether you want the interconnect to support MAC Security (MACsec).

" + } } }, "traits": { @@ -3884,7 +3896,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.

" + "smithy.api#documentation": "

Removes the association between a MAC Security (MACsec) security key and a Direct Connect connection.

" } }, "com.amazonaws.directconnect#DisassociateMacSecKeyRequest": { @@ -3893,7 +3905,7 @@ "connectionId": { "target": "com.amazonaws.directconnect#ConnectionId", "traits": { - "smithy.api#documentation": "

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

\n

You can use DescribeConnections or DescribeLags to retrieve connection ID.

", + "smithy.api#documentation": "

The ID of the dedicated connection (dxcon-xxxx), interconnect (dxcon-xxxx), or LAG (dxlag-xxxx).

\n

You can use DescribeConnections, DescribeInterconnects, or DescribeLags to retrieve connection ID.

", "smithy.api#required": {} } }, @@ -3915,13 +3927,13 @@ "connectionId": { "target": "com.amazonaws.directconnect#ConnectionId", "traits": { - "smithy.api#documentation": "

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

" + "smithy.api#documentation": "

The ID of the dedicated connection (dxcon-xxxx), interconnect (dxcon-xxxx), or LAG (dxlag-xxxx).

" } }, "macSecKeys": { "target": "com.amazonaws.directconnect#MacSecKeyList", "traits": { - "smithy.api#documentation": "

The MAC Security (MACsec) security keys no longer associated with the dedicated connection.

" + "smithy.api#documentation": "

The MAC Security (MACsec) security keys no longer associated with the connection.

" } } }, @@ -4094,6 +4106,30 @@ "traits": { "smithy.api#documentation": "

The name of the service provider associated with the interconnect.

" } + }, + "macSecCapable": { + "target": "com.amazonaws.directconnect#MacSecCapable", + "traits": { + "smithy.api#documentation": "

Indicates whether the interconnect supports MAC Security (MACsec).

" + } + }, + "portEncryptionStatus": { + "target": "com.amazonaws.directconnect#PortEncryptionStatus", + "traits": { + "smithy.api#documentation": "

The MAC Security (MACsec) port link status.

\n

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

" + } + }, + "encryptionMode": { + "target": "com.amazonaws.directconnect#EncryptionMode", + "traits": { + "smithy.api#documentation": "

The MAC Security (MACsec) encryption mode.

\n

The valid values are no_encrypt, should_encrypt, and must_encrypt.

" + } + }, + "macSecKeys": { + "target": "com.amazonaws.directconnect#MacSecKeyList", + "traits": { + "smithy.api#documentation": "

The MAC Security (MACsec) security keys.

" + } } }, "traits": { @@ -6305,6 +6341,9 @@ "com.amazonaws.directconnect#PaginationToken": { "type": "string" }, + "com.amazonaws.directconnect#PartnerInterconnectMacSecCapable": { + "type": "boolean" + }, "com.amazonaws.directconnect#PartnerName": { "type": "string" }, @@ -6774,7 +6813,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the Direct Connect dedicated connection configuration.

\n

You can update the following parameters for a connection:

\n
    \n
  • \n

    The connection name

    \n
    • \n
  • \n

    The connection's MAC Security (MACsec) encryption mode.

    \n
    • \n
" + "smithy.api#documentation": "

Updates the Direct Connect connection configuration.

\n

You can update the following parameters for a connection:

\n
    \n
  • \n

    The connection name

    \n
    • \n
  • \n

    The connection's MAC Security (MACsec) encryption mode.

    \n
    • \n
" } }, "com.amazonaws.directconnect#UpdateConnectionRequest": { @@ -6783,7 +6822,7 @@ "connectionId": { "target": "com.amazonaws.directconnect#ConnectionId", "traits": { - "smithy.api#documentation": "

The ID of the dedicated connection.

\n

You can use DescribeConnections to retrieve the connection ID.

", + "smithy.api#documentation": "

The ID of the connection.

\n

You can use DescribeConnections to retrieve the connection ID.

", "smithy.api#required": {} } }, @@ -7299,6 +7338,12 @@ "smithy.api#enumValue": "down" } }, + "testing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "testing" + } + }, "deleting": { "target": "smithy.api#Unit", "traits": { diff --git a/codegen/sdk/aws-models/directory-service.json b/codegen/sdk/aws-models/directory-service.json index b3f9c5ea2ce..447af2bc577 100644 --- a/codegen/sdk/aws-models/directory-service.json +++ b/codegen/sdk/aws-models/directory-service.json @@ -29,6 +29,21 @@ ] }, "shapes": { + "com.amazonaws.directoryservice#ADAssessmentLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" + }, + "RequestId": { + "target": "com.amazonaws.directoryservice#RequestId" + } + }, + "traits": { + "smithy.api#documentation": "

A directory assessment is automatically created when you create a hybrid directory.\n There are two types of assessments: CUSTOMER and SYSTEM. Your\n Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

\n

If you attempt to create a hybrid directory; and you already have 100\n CUSTOMER directory assessments;, you will encounter an error. Delete\n assessments to free up capacity before trying again.

\n

You can request an increase to your CUSTOMER directory assessment quota\n by contacting customer support or delete existing CUSTOMER directory assessments; to\n free up capacity.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.directoryservice#AcceptSharedDirectory": { "type": "operation", "input": { @@ -370,6 +385,358 @@ "smithy.api#pattern": "^(?!D-|d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$" } }, + "com.amazonaws.directoryservice#Assessment": { + "type": "structure", + "members": { + "AssessmentId": { + "target": "com.amazonaws.directoryservice#AssessmentId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the directory assessment.

" + } + }, + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory associated with this assessment.

" + } + }, + "DnsName": { + "target": "com.amazonaws.directoryservice#DirectoryName", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the Active Directory domain being\n assessed.

" + } + }, + "StartTime": { + "target": "com.amazonaws.directoryservice#AssessmentStartTime", + "traits": { + "smithy.api#documentation": "

The date and time when the assessment was initiated.

" + } + }, + "LastUpdateDateTime": { + "target": "com.amazonaws.directoryservice#LastUpdateDateTime", + "traits": { + "smithy.api#documentation": "

The date and time when the assessment status was last updated.

" + } + }, + "Status": { + "target": "com.amazonaws.directoryservice#AssessmentStatus", + "traits": { + "smithy.api#documentation": "

The current status of the assessment. Valid values include SUCCESS,\n FAILED, PENDING, and IN_PROGRESS.

" + } + }, + "StatusCode": { + "target": "com.amazonaws.directoryservice#AssessmentStatusCode", + "traits": { + "smithy.api#documentation": "

A detailed status code providing additional information about the assessment\n state.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.directoryservice#AssessmentStatusReason", + "traits": { + "smithy.api#documentation": "

A human-readable description of the current assessment status, including any error\n details or progress information.

" + } + }, + "CustomerDnsIps": { + "target": "com.amazonaws.directoryservice#CustomerDnsIps", + "traits": { + "smithy.api#documentation": "

The IP addresses of the DNS servers or domain controllers in your self-managed AD\n environment.

" + } + }, + "VpcId": { + "target": "com.amazonaws.directoryservice#VpcId", + "traits": { + "smithy.api#documentation": "

Contains Amazon VPC information for the StartADAssessment operation.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.directoryservice#SubnetIds", + "traits": { + "smithy.api#documentation": "

A list of subnet identifiers in the Amazon VPC in which the hybrid directory is\n created.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.directoryservice#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The security groups identifiers attached to the network interfaces.

" + } + }, + "SelfManagedInstanceIds": { + "target": "com.amazonaws.directoryservice#AssessmentInstanceIds", + "traits": { + "smithy.api#documentation": "

The identifiers of the self-managed AD instances used to perform the\n assessment.

" + } + }, + "ReportType": { + "target": "com.amazonaws.directoryservice#AssessmentReportType", + "traits": { + "smithy.api#documentation": "

The type of assessment report generated. Valid values are CUSTOMER and\n SYSTEM.

" + } + }, + "Version": { + "target": "com.amazonaws.directoryservice#AssessmentVersion", + "traits": { + "smithy.api#documentation": "

The version of the assessment framework used to evaluate your self-managed AD\n environment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains detailed information about a directory assessment, including configuration\n parameters, status, and validation results.

" + } + }, + "com.amazonaws.directoryservice#AssessmentConfiguration": { + "type": "structure", + "members": { + "CustomerDnsIps": { + "target": "com.amazonaws.directoryservice#CustomerDnsIps", + "traits": { + "smithy.api#documentation": "

A list of IP addresses for the DNS servers or domain controllers in your self-managed\n AD that are tested during the assessment.

", + "smithy.api#required": {} + } + }, + "DnsName": { + "target": "com.amazonaws.directoryservice#DirectoryName", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the self-managed AD domain to assess.

", + "smithy.api#required": {} + } + }, + "VpcSettings": { + "target": "com.amazonaws.directoryservice#DirectoryVpcSettings", + "traits": { + "smithy.api#required": {} + } + }, + "InstanceIds": { + "target": "com.amazonaws.directoryservice#AssessmentInstanceIds", + "traits": { + "smithy.api#documentation": "

The identifiers of the self-managed instances with SSM that are used to perform\n connectivity and validation tests.

", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.directoryservice#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

By default, the service attaches a security group to allow network access to the\n self-managed nodes in your Amazon VPC. You can optionally supply your own security group that\n allows network traffic to and from your self-managed domain controllers outside of your\n Amazon VPC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains configuration parameters required to perform a directory assessment.

" + } + }, + "com.amazonaws.directoryservice#AssessmentId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^da-[0-9a-f]{18}$" + } + }, + "com.amazonaws.directoryservice#AssessmentInstanceId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(i-[0-9a-f]{8}|i-[0-9a-f]{17}|mi-[0-9a-f]{8}|mi-[0-9a-f]{17})$" + } + }, + "com.amazonaws.directoryservice#AssessmentInstanceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservice#AssessmentInstanceId" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.directoryservice#AssessmentLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.directoryservice#AssessmentReport": { + "type": "structure", + "members": { + "DomainControllerIp": { + "target": "com.amazonaws.directoryservice#IpAddr", + "traits": { + "smithy.api#documentation": "

The IP address of the domain controller that was tested during the assessment.

" + } + }, + "Validations": { + "target": "com.amazonaws.directoryservice#AssessmentValidations", + "traits": { + "smithy.api#documentation": "

A list of validation results for different test categories performed against this\n domain controller.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of validation tests performed against a specific domain\n controller during a directory assessment.

" + } + }, + "com.amazonaws.directoryservice#AssessmentReportType": { + "type": "string" + }, + "com.amazonaws.directoryservice#AssessmentReports": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservice#AssessmentReport" + } + }, + "com.amazonaws.directoryservice#AssessmentStartTime": { + "type": "timestamp" + }, + "com.amazonaws.directoryservice#AssessmentStatus": { + "type": "string" + }, + "com.amazonaws.directoryservice#AssessmentStatusCode": { + "type": "string" + }, + "com.amazonaws.directoryservice#AssessmentStatusReason": { + "type": "string" + }, + "com.amazonaws.directoryservice#AssessmentSummary": { + "type": "structure", + "members": { + "AssessmentId": { + "target": "com.amazonaws.directoryservice#AssessmentId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the directory assessment.

" + } + }, + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory associated with this assessment.

" + } + }, + "DnsName": { + "target": "com.amazonaws.directoryservice#DirectoryName", + "traits": { + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the Active Directory domain being\n assessed.

" + } + }, + "StartTime": { + "target": "com.amazonaws.directoryservice#AssessmentStartTime", + "traits": { + "smithy.api#documentation": "

The date and time when the assessment was initiated.

" + } + }, + "LastUpdateDateTime": { + "target": "com.amazonaws.directoryservice#LastUpdateDateTime", + "traits": { + "smithy.api#documentation": "

The date and time when the assessment status was last updated.

" + } + }, + "Status": { + "target": "com.amazonaws.directoryservice#AssessmentStatus", + "traits": { + "smithy.api#documentation": "

The current status of the assessment. Valid values include SUCCESS,\n FAILED, PENDING, and IN_PROGRESS.

" + } + }, + "CustomerDnsIps": { + "target": "com.amazonaws.directoryservice#CustomerDnsIps", + "traits": { + "smithy.api#documentation": "

The IP addresses of the DNS servers or domain controllers in your self-managed AD\n environment.

" + } + }, + "ReportType": { + "target": "com.amazonaws.directoryservice#AssessmentReportType", + "traits": { + "smithy.api#documentation": "

The type of assessment report generated. Valid values include CUSTOMER\n and SYSTEM.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains summary information about a directory assessment, providing a high-level\n overview without detailed validation results.

" + } + }, + "com.amazonaws.directoryservice#AssessmentValidation": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.directoryservice#AssessmentValidationCategory", + "traits": { + "smithy.api#documentation": "

The category of the validation test.

" + } + }, + "Name": { + "target": "com.amazonaws.directoryservice#AssessmentValidationName", + "traits": { + "smithy.api#documentation": "

The name of the specific validation test performed within the category.

" + } + }, + "Status": { + "target": "com.amazonaws.directoryservice#AssessmentValidationStatus", + "traits": { + "smithy.api#documentation": "

The result status of the validation test. Valid values include SUCCESS,\n FAILED, PENDING, and IN_PROGRESS.

" + } + }, + "StatusCode": { + "target": "com.amazonaws.directoryservice#AssessmentValidationStatusCode", + "traits": { + "smithy.api#documentation": "

A detailed status code providing additional information about the validation\n result.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.directoryservice#AssessmentValidationStatusReason", + "traits": { + "smithy.api#documentation": "

A human-readable description of the validation result, including any error details or\n recommendations.

" + } + }, + "StartTime": { + "target": "com.amazonaws.directoryservice#AssessmentValidationTimeStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the validation test was started.

" + } + }, + "LastUpdateDateTime": { + "target": "com.amazonaws.directoryservice#AssessmentValidationTimeStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the validation test was completed or last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a specific validation test performed during a directory\n assessment.

" + } + }, + "com.amazonaws.directoryservice#AssessmentValidationCategory": { + "type": "string" + }, + "com.amazonaws.directoryservice#AssessmentValidationName": { + "type": "string" + }, + "com.amazonaws.directoryservice#AssessmentValidationStatus": { + "type": "string" + }, + "com.amazonaws.directoryservice#AssessmentValidationStatusCode": { + "type": "string" + }, + "com.amazonaws.directoryservice#AssessmentValidationStatusReason": { + "type": "string" + }, + "com.amazonaws.directoryservice#AssessmentValidationTimeStamp": { + "type": "timestamp" + }, + "com.amazonaws.directoryservice#AssessmentValidations": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservice#AssessmentValidation" + } + }, + "com.amazonaws.directoryservice#AssessmentVersion": { + "type": "string" + }, + "com.amazonaws.directoryservice#Assessments": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservice#AssessmentSummary" + } + }, "com.amazonaws.directoryservice#Attribute": { "type": "structure", "members": { @@ -1496,6 +1863,83 @@ "smithy.api#output": {} } }, + "com.amazonaws.directoryservice#CreateHybridAD": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservice#CreateHybridADRequest" + }, + "output": { + "target": "com.amazonaws.directoryservice#CreateHybridADResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservice#ADAssessmentLimitExceededException" + }, + { + "target": "com.amazonaws.directoryservice#ClientException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryLimitExceededException" + }, + { + "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidParameterException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + }, + { + "target": "com.amazonaws.directoryservice#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a hybrid directory that connects your self-managed Active Directory (AD)\n infrastructure and Amazon Web Services.

\n

You must have a successful directory assessment using StartADAssessment to validate your environment compatibility before you\n use this operation.

\n

Updates are applied asynchronously. Use DescribeDirectories to\n monitor the progress of directory creation.

" + } + }, + "com.amazonaws.directoryservice#CreateHybridADRequest": { + "type": "structure", + "members": { + "SecretArn": { + "target": "com.amazonaws.directoryservice#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials for the service account used to join hybrid domain controllers to your\n self-managed AD domain. This secret is used once and not stored.

\n

The secret must contain key-value pairs with keys matching\n customerAdAdminDomainUsername and\n customerAdAdminDomainPassword. For example:\n {\"customerAdAdminDomainUsername\":\"carlos_salazar\",\"customerAdAdminDomainPassword\":\"ExamplePassword123!\"}.

", + "smithy.api#required": {} + } + }, + "AssessmentId": { + "target": "com.amazonaws.directoryservice#AssessmentId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the successful directory assessment that validates your\n self-managed AD environment. You must have a successful directory assessment before you\n create a hybrid directory.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.directoryservice#Tags", + "traits": { + "smithy.api#documentation": "

The tags to be assigned to the directory. Each tag consists of a key and value pair.\n You can specify multiple tags as a list.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservice#CreateHybridADResult": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the newly created hybrid directory.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.directoryservice#CreateLogSubscription": { "type": "operation", "input": { @@ -1892,6 +2336,18 @@ "com.amazonaws.directoryservice#CreatedDateTime": { "type": "timestamp" }, + "com.amazonaws.directoryservice#CustomerDnsIps": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservice#IpAddr" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, "com.amazonaws.directoryservice#CustomerId": { "type": "string", "traits": { @@ -1943,6 +2399,64 @@ } } }, + "com.amazonaws.directoryservice#DeleteADAssessment": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservice#DeleteADAssessmentRequest" + }, + "output": { + "target": "com.amazonaws.directoryservice#DeleteADAssessmentResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservice#ClientException" + }, + { + "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidParameterException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + }, + { + "target": "com.amazonaws.directoryservice#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a directory assessment and all associated data. This operation permanently\n removes the assessment results, validation reports, and configuration\n information.

\n

You cannot delete system-initiated assessments. You can delete customer-created\n assessments even if they are in progress.

" + } + }, + "com.amazonaws.directoryservice#DeleteADAssessmentRequest": { + "type": "structure", + "members": { + "AssessmentId": { + "target": "com.amazonaws.directoryservice#AssessmentId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the directory assessment to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservice#DeleteADAssessmentResult": { + "type": "structure", + "members": { + "AssessmentId": { + "target": "com.amazonaws.directoryservice#AssessmentId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the deleted directory assessment.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.directoryservice#DeleteAssociatedConditionalForwarder": { "type": "boolean", "traits": { @@ -2390,34 +2904,98 @@ ] } }, - "com.amazonaws.directoryservice#DeregisterEventTopicRequest": { + "com.amazonaws.directoryservice#DeregisterEventTopicRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The Directory ID to remove as a publisher. This directory will no longer send messages\n to the specified Amazon SNS topic.

", + "smithy.api#required": {} + } + }, + "TopicName": { + "target": "com.amazonaws.directoryservice#TopicName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon SNS topic from which to remove the directory as a\n publisher.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Removes the specified directory as a publisher to the specified Amazon SNS topic.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservice#DeregisterEventTopicResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The result of a DeregisterEventTopic request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.directoryservice#DescribeADAssessment": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservice#DescribeADAssessmentRequest" + }, + "output": { + "target": "com.amazonaws.directoryservice#DescribeADAssessmentResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservice#ClientException" + }, + { + "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidParameterException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + }, + { + "target": "com.amazonaws.directoryservice#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves detailed information about a directory assessment, including its current\n status, validation results, and configuration details. Use this operation to monitor\n assessment progress and review results.

" + } + }, + "com.amazonaws.directoryservice#DescribeADAssessmentRequest": { "type": "structure", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", - "traits": { - "smithy.api#documentation": "

The Directory ID to remove as a publisher. This directory will no longer send messages\n to the specified Amazon SNS topic.

", - "smithy.api#required": {} - } - }, - "TopicName": { - "target": "com.amazonaws.directoryservice#TopicName", + "AssessmentId": { + "target": "com.amazonaws.directoryservice#AssessmentId", "traits": { - "smithy.api#documentation": "

The name of the Amazon SNS topic from which to remove the directory as a\n publisher.

", + "smithy.api#documentation": "

The identifier of the directory assessment to describe.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Removes the specified directory as a publisher to the specified Amazon SNS topic.

", "smithy.api#input": {} } }, - "com.amazonaws.directoryservice#DeregisterEventTopicResult": { + "com.amazonaws.directoryservice#DescribeADAssessmentResult": { "type": "structure", - "members": {}, + "members": { + "Assessment": { + "target": "com.amazonaws.directoryservice#Assessment", + "traits": { + "smithy.api#documentation": "

Detailed information about the self-managed instance settings (IDs and DNS\n IPs).

" + } + }, + "AssessmentReports": { + "target": "com.amazonaws.directoryservice#AssessmentReports", + "traits": { + "smithy.api#documentation": "

A list of assessment reports containing validation results for each domain controller\n and test category. Each report includes specific validation details and outcomes.

" + } + } + }, "traits": { - "smithy.api#documentation": "

The result of a DeregisterEventTopic request.

", "smithy.api#output": {} } }, @@ -3035,6 +3613,112 @@ "smithy.api#output": {} } }, + "com.amazonaws.directoryservice#DescribeHybridADUpdate": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservice#DescribeHybridADUpdateRequest" + }, + "output": { + "target": "com.amazonaws.directoryservice#DescribeHybridADUpdateResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservice#ClientException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidParameterException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + }, + { + "target": "com.amazonaws.directoryservice#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about update activities for a hybrid directory. This operation\n provides details about configuration changes, administrator account updates, and\n self-managed instance settings (IDs and DNS IPs).

", + "smithy.waiters#waitable": { + "HybridADUpdated": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "UpdateActivities.SelfManagedInstances[].Status", + "expected": "Updated", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "UpdateActivities.SelfManagedInstances[].Status", + "expected": "UpdateFailed", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 120 + } + } + } + }, + "com.amazonaws.directoryservice#DescribeHybridADUpdateRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the hybrid directory for which to retrieve update\n information.

", + "smithy.api#required": {} + } + }, + "UpdateType": { + "target": "com.amazonaws.directoryservice#HybridUpdateType", + "traits": { + "smithy.api#documentation": "

The type of update activities to retrieve. Valid values include\n SelfManagedInstances and\n HybridAdministratorAccount.

" + } + }, + "NextToken": { + "target": "com.amazonaws.directoryservice#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token from a previous request to DescribeHybridADUpdate. Pass null if this is the first request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservice#DescribeHybridADUpdateResult": { + "type": "structure", + "members": { + "UpdateActivities": { + "target": "com.amazonaws.directoryservice#HybridUpdateActivities", + "traits": { + "smithy.api#documentation": "

Information about update activities for the hybrid directory, organized by update\n type.

" + } + }, + "NextToken": { + "target": "com.amazonaws.directoryservice#NextToken", + "traits": { + "smithy.api#documentation": "

If not null, more results are available. Pass this value for the\n NextToken parameter in a subsequent request to retrieve the next set of\n items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.directoryservice#DescribeLDAPSSettings": { "type": "operation", "input": { @@ -4083,6 +4767,12 @@ "traits": { "smithy.api#documentation": "

The operating system (OS) version of the directory.

" } + }, + "HybridSettings": { + "target": "com.amazonaws.directoryservice#HybridSettingsDescription", + "traits": { + "smithy.api#documentation": "

Contains information about the hybrid directory configuration for the directory,\n including Amazon Web Services System Manager managed node identifiers and DNS IPs.

" + } } }, "traits": { @@ -4295,6 +4985,9 @@ { "target": "com.amazonaws.directoryservice#CreateDirectory" }, + { + "target": "com.amazonaws.directoryservice#CreateHybridAD" + }, { "target": "com.amazonaws.directoryservice#CreateLogSubscription" }, @@ -4307,6 +5000,9 @@ { "target": "com.amazonaws.directoryservice#CreateTrust" }, + { + "target": "com.amazonaws.directoryservice#DeleteADAssessment" + }, { "target": "com.amazonaws.directoryservice#DeleteConditionalForwarder" }, @@ -4328,6 +5024,9 @@ { "target": "com.amazonaws.directoryservice#DeregisterEventTopic" }, + { + "target": "com.amazonaws.directoryservice#DescribeADAssessment" + }, { "target": "com.amazonaws.directoryservice#DescribeCertificate" }, @@ -4349,6 +5048,9 @@ { "target": "com.amazonaws.directoryservice#DescribeEventTopics" }, + { + "target": "com.amazonaws.directoryservice#DescribeHybridADUpdate" + }, { "target": "com.amazonaws.directoryservice#DescribeLDAPSSettings" }, @@ -4406,6 +5108,9 @@ { "target": "com.amazonaws.directoryservice#GetSnapshotLimits" }, + { + "target": "com.amazonaws.directoryservice#ListADAssessments" + }, { "target": "com.amazonaws.directoryservice#ListCertificates" }, @@ -4448,6 +5153,9 @@ { "target": "com.amazonaws.directoryservice#ShareDirectory" }, + { + "target": "com.amazonaws.directoryservice#StartADAssessment" + }, { "target": "com.amazonaws.directoryservice#StartSchemaExtension" }, @@ -4460,6 +5168,9 @@ { "target": "com.amazonaws.directoryservice#UpdateDirectorySetup" }, + { + "target": "com.amazonaws.directoryservice#UpdateHybridAD" + }, { "target": "com.amazonaws.directoryservice#UpdateNumberOfDomainControllers" }, @@ -5638,7 +6349,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

" + "smithy.api#documentation": "

Contains VPC information for the CreateDirectory, CreateMicrosoftAD, or CreateHybridAD operation.

" } }, "com.amazonaws.directoryservice#DirectoryVpcSettingsDescription": { @@ -6659,62 +7370,238 @@ { "target": "com.amazonaws.directoryservice#ClientException" }, - { - "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" + { + "target": "com.amazonaws.directoryservice#EntityDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

Obtains the manual snapshot limits for a directory.

", + "smithy.api#examples": [ + { + "title": "To get snapshot limits", + "documentation": "The following example obtains the manual snapshot limits for a specified directory.", + "input": { + "DirectoryId": "d-92654abfed" + }, + "output": { + "SnapshotLimits": { + "ManualSnapshotsCurrentCount": 1, + "ManualSnapshotsLimit": 5, + "ManualSnapshotsLimitReached": false + } + } + } + ] + } + }, + "com.amazonaws.directoryservice#GetSnapshotLimitsRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

Contains the identifier of the directory to obtain the limits for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the inputs for the GetSnapshotLimits operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservice#GetSnapshotLimitsResult": { + "type": "structure", + "members": { + "SnapshotLimits": { + "target": "com.amazonaws.directoryservice#SnapshotLimits", + "traits": { + "smithy.api#documentation": "

A SnapshotLimits object that contains the manual snapshot limits for the specified\n directory.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of the GetSnapshotLimits operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.directoryservice#HybridAdministratorAccountUpdate": { + "type": "structure", + "members": { + "SecretArn": { + "target": "com.amazonaws.directoryservice#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the\n credentials for the AD administrator user, and enables hybrid domain controllers to\n join the managed AD domain. For example:

\n

\n \n {\"customerAdAdminDomainUsername\":\"carlos_salazar\",\"customerAdAdminDomainPassword\":\"ExamplePassword123!\"}.\n \n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Use to recover to the hybrid directory administrator account credentials.

" + } + }, + "com.amazonaws.directoryservice#HybridCustomerInstancesSettings": { + "type": "structure", + "members": { + "CustomerDnsIps": { + "target": "com.amazonaws.directoryservice#CustomerDnsIps", + "traits": { + "smithy.api#documentation": "

The IP addresses of the DNS servers or domain controllers in your self-managed AD\n environment.

", + "smithy.api#required": {} + } + }, + "InstanceIds": { + "target": "com.amazonaws.directoryservice#AssessmentInstanceIds", + "traits": { + "smithy.api#documentation": "

The identifiers of the self-managed instances with SSM used in hybrid\n directory.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains configuration settings for self-managed instances with SSM used in hybrid\n directory operations.

" + } + }, + "com.amazonaws.directoryservice#HybridSettingsDescription": { + "type": "structure", + "members": { + "SelfManagedDnsIpAddrs": { + "target": "com.amazonaws.directoryservice#IpAddrs", + "traits": { + "smithy.api#documentation": "

The IP addresses of the DNS servers in your self-managed AD environment.

" + } + }, + "SelfManagedInstanceIds": { + "target": "com.amazonaws.directoryservice#AssessmentInstanceIds", + "traits": { + "smithy.api#documentation": "

The identifiers of the self-managed instances with SSM used for hybrid directory\n operations.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the current hybrid directory configuration settings for a directory.

" + } + }, + "com.amazonaws.directoryservice#HybridUpdateActivities": { + "type": "structure", + "members": { + "SelfManagedInstances": { + "target": "com.amazonaws.directoryservice#HybridUpdateInfoEntries", + "traits": { + "smithy.api#documentation": "

A list of update activities related to the self-managed instances with SSM in the\n self-managed instances with SSM hybrid directory configuration.

" + } + }, + "HybridAdministratorAccount": { + "target": "com.amazonaws.directoryservice#HybridUpdateInfoEntries", + "traits": { + "smithy.api#documentation": "

A list of update activities related to hybrid directory administrator account\n changes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about update activities for different components of a hybrid\n directory.

" + } + }, + "com.amazonaws.directoryservice#HybridUpdateInfoEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservice#HybridUpdateInfoEntry" + } + }, + "com.amazonaws.directoryservice#HybridUpdateInfoEntry": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.directoryservice#UpdateStatus", + "traits": { + "smithy.api#documentation": "

The current status of the update activity. Valid values include UPDATED,\n UPDATING, and UPDATE_FAILED.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.directoryservice#UpdateStatusReason", + "traits": { + "smithy.api#documentation": "

A human-readable description of the update status, including any error details or\n progress information.

" + } + }, + "InitiatedBy": { + "target": "com.amazonaws.directoryservice#InitiatedBy", + "traits": { + "smithy.api#documentation": "

Specifies if the update was initiated by the customer or Amazon Web Services.

" + } + }, + "NewValue": { + "target": "com.amazonaws.directoryservice#HybridUpdateValue", + "traits": { + "smithy.api#documentation": "

The new configuration values being applied in this update.

" + } + }, + "PreviousValue": { + "target": "com.amazonaws.directoryservice#HybridUpdateValue", + "traits": { + "smithy.api#documentation": "

The previous configuration values before this update was applied.

" + } + }, + "StartTime": { + "target": "com.amazonaws.directoryservice#StartDateTime", + "traits": { + "smithy.api#documentation": "

The date and time when the update activity was initiated.

" + } }, - { - "target": "com.amazonaws.directoryservice#ServiceException" + "LastUpdatedDateTime": { + "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", + "traits": { + "smithy.api#documentation": "

The date and time when the update activity status was last updated.

" + } + }, + "AssessmentId": { + "target": "com.amazonaws.directoryservice#AssessmentId", + "traits": { + "smithy.api#documentation": "

The identifier of the assessment performed to validate this update\n configuration.

" + } } - ], + }, "traits": { - "smithy.api#documentation": "

Obtains the manual snapshot limits for a directory.

", - "smithy.api#examples": [ - { - "title": "To get snapshot limits", - "documentation": "The following example obtains the manual snapshot limits for a specified directory.", - "input": { - "DirectoryId": "d-92654abfed" - }, - "output": { - "SnapshotLimits": { - "ManualSnapshotsCurrentCount": 1, - "ManualSnapshotsLimit": 5, - "ManualSnapshotsLimitReached": false - } - } - } - ] + "smithy.api#documentation": "

Contains detailed information about a specific update activity for a hybrid directory\n component.

" } }, - "com.amazonaws.directoryservice#GetSnapshotLimitsRequest": { - "type": "structure", + "com.amazonaws.directoryservice#HybridUpdateType": { + "type": "enum", "members": { - "DirectoryId": { - "target": "com.amazonaws.directoryservice#DirectoryId", + "SELF_MANAGED_INSTANCES": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Contains the identifier of the directory to obtain the limits for.

", - "smithy.api#required": {} + "smithy.api#enumValue": "SelfManagedInstances" + } + }, + "HYBRID_ADMINISTRATOR_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HybridAdministratorAccount" } } - }, - "traits": { - "smithy.api#documentation": "

Contains the inputs for the GetSnapshotLimits operation.

", - "smithy.api#input": {} } }, - "com.amazonaws.directoryservice#GetSnapshotLimitsResult": { + "com.amazonaws.directoryservice#HybridUpdateValue": { "type": "structure", "members": { - "SnapshotLimits": { - "target": "com.amazonaws.directoryservice#SnapshotLimits", + "InstanceIds": { + "target": "com.amazonaws.directoryservice#AssessmentInstanceIds", "traits": { - "smithy.api#documentation": "

A SnapshotLimits object that contains the manual snapshot limits for the specified\n directory.

" + "smithy.api#documentation": "

The identifiers of the self-managed instances with SSM in the hybrid directory\n configuration.

" + } + }, + "DnsIps": { + "target": "com.amazonaws.directoryservice#CustomerDnsIps", + "traits": { + "smithy.api#documentation": "

The IP addresses of the DNS servers or domain controllers in the hybrid directory\n configuration.

" } } }, "traits": { - "smithy.api#documentation": "

Contains the results of the GetSnapshotLimits operation.

", - "smithy.api#output": {} + "smithy.api#documentation": "

Contains the configuration values for a hybrid directory update, including Amazon Web Services\n System Manager managed node and DNS information.

" } }, "com.amazonaws.directoryservice#IncompatibleSettingsException": { @@ -7077,6 +7964,9 @@ } } }, + "com.amazonaws.directoryservice#LastUpdateDateTime": { + "type": "timestamp" + }, "com.amazonaws.directoryservice#LastUpdatedDateTime": { "type": "timestamp" }, @@ -7100,6 +7990,87 @@ } } }, + "com.amazonaws.directoryservice#ListADAssessments": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservice#ListADAssessmentsRequest" + }, + "output": { + "target": "com.amazonaws.directoryservice#ListADAssessmentsResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservice#ClientException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidParameterException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + }, + { + "target": "com.amazonaws.directoryservice#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of directory assessments for the specified directory or all\n assessments in your account. Use this operation to monitor assessment status and manage\n multiple assessments.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Assessments", + "pageSize": "Limit" + } + } + }, + "com.amazonaws.directoryservice#ListADAssessmentsRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory for which to list assessments. If not specified, all\n assessments in your account are returned.

" + } + }, + "NextToken": { + "target": "com.amazonaws.directoryservice#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token from a previous request to ListADAssessments.\n Pass null if this is the first request.

" + } + }, + "Limit": { + "target": "com.amazonaws.directoryservice#AssessmentLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of assessment summaries to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservice#ListADAssessmentsResult": { + "type": "structure", + "members": { + "Assessments": { + "target": "com.amazonaws.directoryservice#Assessments", + "traits": { + "smithy.api#documentation": "

A list of assessment summaries containing basic information about each directory\n assessment.

" + } + }, + "NextToken": { + "target": "com.amazonaws.directoryservice#NextToken", + "traits": { + "smithy.api#documentation": "

If not null, more results are available. Pass this value for the\n NextToken parameter in a subsequent request to retrieve the next set of\n items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.directoryservice#ListCertificates": { "type": "operation", "input": { @@ -8766,12 +9737,30 @@ "target": "com.amazonaws.directoryservice#SchemaExtensionInfo" } }, + "com.amazonaws.directoryservice#SecretArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:secretsmanager:[a-z0-9-]+:\\d{12}:secret:[a-zA-Z0-9/_+=.@-]+-[a-zA-Z0-9]{6}$" + } + }, "com.amazonaws.directoryservice#SecurityGroupId": { "type": "string", "traits": { "smithy.api#pattern": "^(sg-[0-9a-f]{8}|sg-[0-9a-f]{17})$" } }, + "com.amazonaws.directoryservice#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservice#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.directoryservice#SelectiveAuth": { "type": "enum", "members": { @@ -9370,6 +10359,72 @@ "com.amazonaws.directoryservice#StageReason": { "type": "string" }, + "com.amazonaws.directoryservice#StartADAssessment": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservice#StartADAssessmentRequest" + }, + "output": { + "target": "com.amazonaws.directoryservice#StartADAssessmentResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservice#ADAssessmentLimitExceededException" + }, + { + "target": "com.amazonaws.directoryservice#ClientException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidParameterException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + }, + { + "target": "com.amazonaws.directoryservice#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Initiates a directory assessment to validate your self-managed AD environment for\n hybrid domain join. The assessment checks compatibility and connectivity of the\n self-managed AD environment.

\n

A directory assessment is automatically created when you create a hybrid directory.\n There are two types of assessments: CUSTOMER and SYSTEM. Your\n Amazon Web Services account has a limit of 100 CUSTOMER directory assessments.

\n

The assessment process typically takes 30 minutes or more to complete. The assessment\n process is asynchronous and you can monitor it with\n DescribeADAssessment.

\n

The InstanceIds must have a one-to-one correspondence with\n CustomerDnsIps, meaning that if the IP address for instance i-10243410\n is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the\n input arrays must maintain the same order relationship, either [10.24.34.100,\n 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100]\n paired with [i-10243420, i-10243410].

\n

Note: You must provide exactly one DirectoryId or\n AssessmentConfiguration.

" + } + }, + "com.amazonaws.directoryservice#StartADAssessmentRequest": { + "type": "structure", + "members": { + "AssessmentConfiguration": { + "target": "com.amazonaws.directoryservice#AssessmentConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration parameters for the directory assessment, including DNS server\n information, domain name, Amazon VPC subnet, and Amazon Web Services System Manager managed node\n details.

" + } + }, + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory for which to perform the assessment. This should be an\n existing directory. If the assessment is not for an existing directory, this parameter\n should be omitted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservice#StartADAssessmentResult": { + "type": "structure", + "members": { + "AssessmentId": { + "target": "com.amazonaws.directoryservice#AssessmentId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the newly started directory assessment. Use this identifier\n to monitor assessment progress and retrieve results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.directoryservice#StartDateTime": { "type": "timestamp" }, @@ -10136,6 +11191,85 @@ "smithy.api#output": {} } }, + "com.amazonaws.directoryservice#UpdateHybridAD": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservice#UpdateHybridADRequest" + }, + "output": { + "target": "com.amazonaws.directoryservice#UpdateHybridADResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservice#ADAssessmentLimitExceededException" + }, + { + "target": "com.amazonaws.directoryservice#ClientException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidParameterException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + }, + { + "target": "com.amazonaws.directoryservice#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the configuration of an existing hybrid directory. You can recover hybrid\n directory administrator account or modify self-managed instance settings.

\n

Updates are applied asynchronously. Use DescribeHybridADUpdate to\n monitor the progress of configuration changes.

\n

The InstanceIds must have a one-to-one correspondence with\n CustomerDnsIps, meaning that if the IP address for instance i-10243410\n is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the\n input arrays must maintain the same order relationship, either [10.24.34.100,\n 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100]\n paired with [i-10243420, i-10243410].

\n \n

You must provide at least one update to UpdateHybridADRequest$HybridAdministratorAccountUpdate or UpdateHybridADRequest$SelfManagedInstancesSettings.

\n " + } + }, + "com.amazonaws.directoryservice#UpdateHybridADRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the hybrid directory to update.

", + "smithy.api#required": {} + } + }, + "HybridAdministratorAccountUpdate": { + "target": "com.amazonaws.directoryservice#HybridAdministratorAccountUpdate", + "traits": { + "smithy.api#documentation": "

We create a hybrid directory administrator account when we create a hybrid directory.\n Use HybridAdministratorAccountUpdate to recover the hybrid directory\n administrator account if you have deleted it.

\n

To recover your hybrid directory administrator account, we need temporary access to a\n user in your self-managed AD with administrator permissions in the form of a secret from\n Amazon Web Services Secrets Manager. We use these credentials once during recovery and don't store them.

\n

If your hybrid directory administrator account exists, then you don’t need to use\n HybridAdministratorAccountUpdate, even if you have updated your\n self-managed AD administrator user.

" + } + }, + "SelfManagedInstancesSettings": { + "target": "com.amazonaws.directoryservice#HybridCustomerInstancesSettings", + "traits": { + "smithy.api#documentation": "

Updates to the self-managed AD configuration, including DNS server IP addresses and\n Amazon Web Services System Manager managed node identifiers.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservice#UpdateHybridADResult": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the updated hybrid directory.

" + } + }, + "AssessmentId": { + "target": "com.amazonaws.directoryservice#AssessmentId", + "traits": { + "smithy.api#documentation": "

The identifier of the assessment performed to validate the update configuration. This\n assessment ensures the updated settings are compatible with your environment.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.directoryservice#UpdateInfoEntry": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/docdb.json b/codegen/sdk/aws-models/docdb.json index cd716554b9e..b898e6b733d 100644 --- a/codegen/sdk/aws-models/docdb.json +++ b/codegen/sdk/aws-models/docdb.json @@ -2025,6 +2025,12 @@ "smithy.api#documentation": "

The storage type to associate with the DB cluster.

\n

For information on storage types for Amazon DocumentDB clusters, see \n Cluster storage configurations in the Amazon DocumentDB Developer Guide.

\n

Valid values for storage type - standard | iopt1\n

\n

Default value is standard \n

\n \n

When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned\n in the response. The storage type isn't returned when you set it to standard.

\n " } }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.docdb#ServerlessV2ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.

" + } + }, "ManageMasterUserPassword": { "target": "com.amazonaws.docdb#BooleanOptional", "traits": { @@ -2828,7 +2834,13 @@ "StorageType": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Storage type associated with your cluster

\n

Storage type associated with your cluster

\n

For information on storage types for Amazon DocumentDB clusters, see \n Cluster storage configurations in the Amazon DocumentDB Developer Guide.

\n

Valid values for storage type - standard | iopt1\n

\n

Default value is standard \n

" + "smithy.api#documentation": "

Storage type associated with your cluster

\n

For information on storage types for Amazon DocumentDB clusters, see \n Cluster storage configurations in the Amazon DocumentDB Developer Guide.

\n

Valid values for storage type - standard | iopt1\n

\n

Default value is standard \n

" + } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.docdb#ServerlessV2ScalingConfigurationInfo", + "traits": { + "smithy.api#documentation": "

The scaling configuration of an Amazon DocumentDB Serverless cluster.

" } }, "MasterUserSecret": { @@ -3224,7 +3236,7 @@ "StorageType": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

Storage type associated with your cluster snapshot

\n

For information on storage types for Amazon DocumentDB clusters, see \n Cluster storage configurations in the Amazon DocumentDB Developer Guide.

\n

Valid values for storage type - standard | iopt1\n

\n

Default value is standard \n

" + "smithy.api#documentation": "

Storage type associated with your cluster snapshot

\n

For information on storage types for Amazon DocumentDB clusters, see \n Cluster storage configurations in the Amazon DocumentDB Developer Guide.

\n

Valid values for storage type - standard | iopt1\n

\n

Default value is standard \n

" } } }, @@ -3407,6 +3419,12 @@ "traits": { "smithy.api#documentation": "

Indicates whether the engine version supports rotating the server certificate without \n rebooting the DB instance.

" } + }, + "ServerlessV2FeaturesSupport": { + "target": "com.amazonaws.docdb#ServerlessV2FeaturesSupport", + "traits": { + "smithy.api#documentation": "

Specifies any Amazon DocumentDB Serverless properties or limits that differ between Amazon DocumentDB engine versions. \n You can test the values of this attribute when deciding which Amazon DocumentDB version to use in a new or upgraded cluster. \n You can also retrieve the version of an existing cluster and check whether that version supports certain Amazon DocumentDB Serverless features before you attempt to use those features.

" + } } }, "traits": { @@ -5485,6 +5503,9 @@ "smithy.api#input": {} } }, + "com.amazonaws.docdb#DoubleOptional": { + "type": "double" + }, "com.amazonaws.docdb#Endpoint": { "type": "structure", "members": { @@ -5964,7 +5985,7 @@ "GlobalClusterResourceId": { "target": "com.amazonaws.docdb#String", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.

" + "smithy.api#documentation": "

The Amazon Web Services RegionRegion-unique, immutable identifier for the global database cluster. \n This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.

" } }, "GlobalClusterArn": { @@ -6068,7 +6089,7 @@ "Readers": { "target": "com.amazonaws.docdb#ReadersArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Amazon DocumentDB global cluster.

" } }, "IsWriter": { @@ -6657,6 +6678,12 @@ "smithy.api#documentation": "

The storage type to associate with the DB cluster.

\n

For information on storage types for Amazon DocumentDB clusters, see \n Cluster storage configurations in the Amazon DocumentDB Developer Guide.

\n

Valid values for storage type - standard | iopt1\n

\n

Default value is standard \n

" } }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.docdb#ServerlessV2ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.

" + } + }, "ManageMasterUserPassword": { "target": "com.amazonaws.docdb#BooleanOptional", "traits": { @@ -7983,6 +8010,12 @@ "smithy.api#documentation": "

The name of the DB cluster parameter group to associate with this DB cluster.

\n

\n Type: String.       Required: No.

\n

If this argument is omitted, the default DB cluster parameter group is used.\n If supplied, must match the name of an existing default DB cluster parameter group.\n The string must consist of from 1 to 255 letters, numbers or hyphens. Its first\n character must be a letter, and it cannot end with a hyphen or contain two consecutive\n hyphens.

" } }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.docdb#ServerlessV2ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.

" + } + }, "StorageType": { "target": "com.amazonaws.docdb#String", "traits": { @@ -8144,6 +8177,12 @@ "smithy.api#documentation": "

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

" } }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.docdb#ServerlessV2ScalingConfiguration", + "traits": { + "smithy.api#documentation": "

Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.

" + } + }, "StorageType": { "target": "com.amazonaws.docdb#String", "traits": { @@ -8218,6 +8257,66 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.docdb#ServerlessV2FeaturesSupport": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.docdb#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. \n You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.docdb#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.\n You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies any Amazon DocumentDB Serverless properties or limits that differ between Amazon DocumentDB engine versions. \n You can test the values of this attribute when deciding which Amazon DocumentDB version to use in a new or upgraded cluster. \n You can also retrieve the version of an existing cluster and check whether that version supports certain Amazon DocumentDB Serverless features before you attempt to use those features.

" + } + }, + "com.amazonaws.docdb#ServerlessV2ScalingConfiguration": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.docdb#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. \n You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.docdb#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.\n You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Sets the scaling configuration of an Amazon DocumentDB Serverless cluster.

" + } + }, + "com.amazonaws.docdb#ServerlessV2ScalingConfigurationInfo": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.docdb#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. \n You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.docdb#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. \n You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Retrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.

" + } + }, "com.amazonaws.docdb#SharedSnapshotQuotaExceededFault": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index 666c8a2f2fd..b1ed9af5966 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -1641,7 +1641,7 @@ "target": "com.amazonaws.ec2#AdvertiseByoipCidrResult" }, "traits": { - "smithy.api#documentation": "

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through \n bring your own IP addresses (BYOIP).

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise\n it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a\n BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current \n location and start advertising it through Amazon Web Services.

\n

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services\n because of BGP propagation delays.

\n

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

" + "smithy.api#documentation": "

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through \n bring your own IP addresses (BYOIP).

\n

You can perform this operation at most once every 10 seconds, even if you specify different \n address ranges each time.

\n

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise\n it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a\n BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current \n location and start advertising it through Amazon Web Services.

\n

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services\n because of BGP propagation delays.

" } }, "com.amazonaws.ec2#AdvertiseByoipCidrRequest": { @@ -16042,7 +16042,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance type for which to reserve capacity.

\n \n

You can request future-dated Capacity Reservations for instance types in the C, M,\n\t\t\t\tR, I, and T instance families only.

\n \n

For more information, see Instance types in the\n\t\t\t\tAmazon EC2 User Guide.

", + "smithy.api#documentation": "

The instance type for which to reserve capacity.

\n \n

You can request future-dated Capacity Reservations for instance types in the C, M,\n\t\t\t\tR, I, T, and G instance families only.

\n \n

For more information, see Instance types in the\n\t\t\t\tAmazon EC2 User Guide.

", "smithy.api#required": {} } }, @@ -16076,7 +16076,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The number of instances for which to reserve capacity.

\n \n

You can request future-dated Capacity Reservations for an instance count with a\n\t\t\t\tminimum of 100 vCPUs. For example, if you request a future-dated Capacity\n\t\t\t\tReservation for m5.xlarge instances, you must request at least 25\n\t\t\t\tinstances (25 * m5.xlarge = 100 vCPUs).

\n \n

Valid range: 1 - 1000

", + "smithy.api#documentation": "

The number of instances for which to reserve capacity.

\n \n

You can request future-dated Capacity Reservations for an instance count with a\n\t\t\t\tminimum of 64 vCPUs. For example, if you request a future-dated Capacity\n\t\t\t\tReservation for m5.xlarge instances, you must request at least 25\n\t\t\t\tinstances (16 * m5.xlarge = 64 vCPUs).

\n \n

Valid range: 1 - 1000

", "smithy.api#required": {} } }, @@ -17624,7 +17624,7 @@ "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#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), copy the image instead.

    \n
    • \n
  • \n

    The only option that can be changed for existing mappings or snapshots is\n DeleteOnTermination.

    \n
    • \n
", "smithy.api#xmlName": "blockDeviceMapping" } } @@ -29884,7 +29884,7 @@ "target": "com.amazonaws.ec2#DeprovisionByoipCidrResult" }, "traits": { - "smithy.api#documentation": "

Releases the specified address range that you provisioned for use with your Amazon Web Services resources\n through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

\n

Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its\n address range.

" + "smithy.api#documentation": "

Releases the specified address range that you provisioned for use with your Amazon Web Services resources\n through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

\n

Before you can release an address range, you must stop advertising it and you must not \n have any IP addresses allocated from its address range.

" } }, "com.amazonaws.ec2#DeprovisionByoipCidrRequest": { @@ -31088,7 +31088,7 @@ "target": "com.amazonaws.ec2#DescribeByoipCidrsResult" }, "traits": { - "smithy.api#documentation": "

Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.

\n

To describe the address pools that were created when you provisioned the address\n ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.

", + "smithy.api#documentation": "

Describes the IP address ranges that were provisioned for use with Amazon Web Services resources\n through through bring your own IP addresses (BYOIP).

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -34930,7 +34930,7 @@ "target": "com.amazonaws.ec2#ImageAttributeName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The AMI attribute.

\n

\n Note: The blockDeviceMapping attribute is\n deprecated. Using this attribute returns the Client.AuthFailure error. To get\n information about the block device mappings for an AMI, use the DescribeImages action.

", + "smithy.api#documentation": "

The AMI attribute.

\n

\n Note: The blockDeviceMapping attribute is\n deprecated. Using this attribute returns the Client.AuthFailure error. To get\n information about the block device mappings for an AMI, describe the image instead.

", "smithy.api#required": {} } }, @@ -34965,7 +34965,7 @@ "target": "com.amazonaws.ec2#DescribeImagesResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the\n images available to you.

\n

The images available to you include public images, private images that you own, and\n private images owned by other Amazon Web Services accounts for which you have explicit launch\n permissions.

\n

Recently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.

\n

When Allowed AMIs is set to enabled, only allowed images are returned in the\n results, with the imageAllowed field set to true for each image. In\n audit-mode, the imageAllowed field is set to true for\n images that meet the account's Allowed AMIs criteria, and false for images that\n don't meet the criteria. For more information, see EnableAllowedImagesSettings.

\n

The Amazon EC2 API follows an eventual consistency model. This means that the result of an API\n command you run that creates or modifies resources might not be immediately available to all\n subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual\n consistency in the Amazon EC2 API in the Amazon EC2 Developer\n Guide.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n \n \n

The order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.

\n ", + "smithy.api#documentation": "

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the\n images available to you.

\n

The images available to you include public images, private images that you own, and\n private images owned by other Amazon Web Services accounts for which you have explicit launch\n permissions.

\n

Recently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.

\n

When Allowed AMIs is set to enabled, only allowed images are returned in the\n results, with the imageAllowed field set to true for each image. In\n audit-mode, the imageAllowed field is set to true for\n images that meet the account's Allowed AMIs criteria, and false for images that\n don't meet the criteria. For more information, see Allowed AMIs.

\n

The Amazon EC2 API follows an eventual consistency model. This means that the result of an API\n command you run that creates or modifies resources might not be immediately available to all\n subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual\n consistency in the Amazon EC2 API in the Amazon EC2 Developer\n Guide.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n \n \n

The order of the elements in the response, including those within nested structures,\n might vary. Applications should not assume the elements appear in a particular order.

\n ", "smithy.api#examples": [ { "title": "To describe an AMI", @@ -35126,7 +35126,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n architecture - The image architecture (i386 |\n x86_64 | arm64 | x86_64_mac |\n arm64_mac).

    \n
    • \n
  • \n

    \n block-device-mapping.delete-on-termination - A Boolean value that indicates\n whether 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\n device mapping (for 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\n 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\n 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 with\n ENA is enabled.

    \n
    • \n
  • \n

    \n hypervisor - The hypervisor type (ovm |\n xen).

    \n
    • \n
  • \n

    \n image-allowed - A Boolean that indicates whether the image meets the\n criteria specified for Allowed AMIs.

    \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 |\n aws-backup-vault | aws-marketplace). The valid aliases are\n defined in an Amazon-maintained list. This is not the Amazon Web Services account alias\n that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.

    \n
    • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the owner. We recommend\n that you use the Owner request parameter instead of this\n filter.

    \n
    • \n
  • \n

    \n platform - The platform. The only supported value is\n windows.

    \n
    • \n
  • \n

    \n product-code - The product code.

    \n
    • \n
  • \n

    \n product-code.type - The type of the product code\n (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,\n /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-image-id - The ID of the source AMI from which the AMI was\n created.

    \n
    • \n
  • \n

    \n source-image-region - The Region of the source AMI.

    \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 that\n 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#documentation": "

The filters.

\n
    \n
  • \n

    \n architecture - The image architecture (i386 |\n x86_64 | arm64 | x86_64_mac |\n arm64_mac).

    \n
    • \n
  • \n

    \n block-device-mapping.delete-on-termination - A Boolean value that indicates\n whether 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\n device mapping (for 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\n 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\n 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 with\n ENA is enabled.

    \n
    • \n
  • \n

    \n free-tier-eligible - A Boolean that indicates whether this image can be\n used under the Amazon Web Services Free Tier (true | false).

    \n
    • \n
  • \n

    \n hypervisor - The hypervisor type (ovm |\n xen).

    \n
    • \n
  • \n

    \n image-allowed - A Boolean that indicates whether the image meets the\n criteria specified for Allowed AMIs.

    \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 |\n aws-backup-vault | aws-marketplace). The valid aliases are\n defined in an Amazon-maintained list. This is not the Amazon Web Services account alias\n that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.

    \n
    • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the owner. We recommend\n that you use the Owner request parameter instead of this\n filter.

    \n
    • \n
  • \n

    \n platform - The platform. The only supported value is\n windows.

    \n
    • \n
  • \n

    \n product-code - The product code.

    \n
    • \n
  • \n

    \n product-code.type - The type of the product code\n (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,\n /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-image-id - The ID of the source AMI from which the AMI was\n created.

    \n
    • \n
  • \n

    \n source-image-region - The Region of the source AMI.

    \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 that\n 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" } } @@ -36236,7 +36236,7 @@ "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 auto-recovery-supported - Indicates whether Amazon CloudWatch action\n based recovery is supported (true | false).

    \n
    • \n
  • \n

    \n bare-metal - Indicates whether it is a bare metal instance type\n (true | false).

    \n
    • \n
  • \n

    \n burstable-performance-supported - Indicates whether the instance type is a\n burstable performance T instance type (true | false).

    \n
    • \n
  • \n

    \n current-generation - Indicates whether this instance type is the latest\n generation instance type of an instance family (true | false).

    \n
    • \n
  • \n

    \n dedicated-hosts-supported - Indicates whether the instance type supports\n Dedicated Hosts. (true | false)

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline\n bandwidth performance for an EBS-optimized instance type, in Mbps.

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage\n operations per second for an EBS-optimized instance type.

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline\n throughput performance for an EBS-optimized instance type, in MB/s.

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth\n performance for an EBS-optimized instance type, in Mbps.

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage\n operations per second for an EBS-optimized instance type.

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum\n throughput performance for an EBS-optimized instance type, in MB/s.

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-support - Indicates whether the instance type is\n EBS-optimized (supported | unsupported |\n default).

    \n
    • \n
  • \n

    \n ebs-info.encryption-support - Indicates whether EBS encryption is supported\n (supported | unsupported).

    \n
    • \n
  • \n

    \n ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)\n is supported for EBS volumes (required | supported |\n unsupported).

    \n
    • \n
  • \n

    \n free-tier-eligible - Indicates whether the instance type is eligible to use\n in the free tier (true | false).

    \n
    • \n
  • \n

    \n hibernation-supported - Indicates whether On-Demand hibernation is supported\n (true | false).

    \n
    • \n
  • \n

    \n hypervisor - The hypervisor (nitro | xen).

    \n
    • \n
  • \n

    \n instance-storage-info.disk.count - The number of local disks.

    \n
    • \n
  • \n

    \n instance-storage-info.disk.size-in-gb - The storage size of each instance\n storage disk, in GB.

    \n
    • \n
  • \n

    \n instance-storage-info.disk.type - The storage technology for the local\n instance storage disks (hdd | ssd).

    \n
    • \n
  • \n

    \n instance-storage-info.encryption-support - Indicates whether data is\n encrypted at rest (required | supported |\n unsupported).

    \n
    • \n
  • \n

    \n instance-storage-info.nvme-support - Indicates whether non-volatile memory\n express (NVMe) is supported for instance store (required | supported\n | unsupported).

    \n
    • \n
  • \n

    \n instance-storage-info.total-size-in-gb - The total amount of storage\n available from all local instance storage, in GB.

    \n
    • \n
  • \n

    \n instance-storage-supported - Indicates whether the instance type has local\n instance storage (true | false).

    \n
    • \n
  • \n

    \n instance-type - The instance type (for example c5.2xlarge or\n c5*).

    \n
    • \n
  • \n

    \n memory-info.size-in-mib - The memory size.

    \n
    • \n
  • \n

    \n network-info.bandwidth-weightings - For instances that support bandwidth\n weighting to boost performance (default, vpc-1,\n ebs-1).

    \n
    • \n
  • \n

    \n network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic\n Fabric Adapters (EFAs) per instance.

    \n
    • \n
  • \n

    \n network-info.efa-supported - Indicates whether the instance type supports\n Elastic Fabric Adapter (EFA) (true | false).

    \n
    • \n
  • \n

    \n network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is\n supported or required (required | supported |\n unsupported).

    \n
    • \n
  • \n

    \n network-info.flexible-ena-queues-support - Indicates whether an instance supports\n flexible ENA queues (supported | unsupported).

    \n
    • \n
  • \n

    \n network-info.encryption-in-transit-supported - Indicates whether the instance\n type automatically encrypts in-transit traffic between instances (true | false).

    \n
    • \n
  • \n

    \n network-info.ipv4-addresses-per-interface - The maximum number of private\n IPv4 addresses per network interface.

    \n
    • \n
  • \n

    \n network-info.ipv6-addresses-per-interface - The maximum number of private\n IPv6 addresses per network interface.

    \n
    • \n
  • \n

    \n network-info.ipv6-supported - Indicates whether the instance type supports\n IPv6 (true | false).

    \n
    • \n
  • \n

    \n network-info.maximum-network-cards - The maximum number of network cards per\n instance.

    \n
    • \n
  • \n

    \n network-info.maximum-network-interfaces - The maximum number of network\n interfaces per instance.

    \n
    • \n
  • \n

    \n network-info.network-performance - The network performance (for example, \"25\n Gigabit\").

    \n
    • \n
  • \n

    \n nitro-enclaves-support - Indicates whether Nitro Enclaves is supported\n (supported | unsupported).

    \n
    • \n
  • \n

    \n nitro-tpm-support - Indicates whether NitroTPM is supported\n (supported | unsupported).

    \n
    • \n
  • \n

    \n nitro-tpm-info.supported-versions - The supported NitroTPM version\n (2.0).

    \n
    • \n
  • \n

    \n processor-info.supported-architecture - The CPU architecture\n (arm64 | i386 | x86_64).

    \n
    • \n
  • \n

    \n processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in\n GHz.

    \n
    • \n
  • \n

    \n processor-info.supported-features - The supported CPU features\n (amd-sev-snp).

    \n
    • \n
  • \n

    \n reboot-migration-support - Indicates whether enabling reboot migration is\n supported (supported | unsupported).

    \n
    • \n
  • \n

    \n supported-boot-mode - The boot mode (legacy-bios |\n uefi).

    \n
    • \n
  • \n

    \n supported-root-device-type - The root device type (ebs |\n instance-store).

    \n
    • \n
  • \n

    \n supported-usage-class - The usage class (on-demand |\n spot | capacity-block).

    \n
    • \n
  • \n

    \n supported-virtualization-type - The virtualization type (hvm |\n paravirtual).

    \n
    • \n
  • \n

    \n vcpu-info.default-cores - The default number of cores for the instance\n type.

    \n
    • \n
  • \n

    \n vcpu-info.default-threads-per-core - The default number of threads per core\n for the instance type.

    \n
    • \n
  • \n

    \n vcpu-info.default-vcpus - The default number of vCPUs for the instance\n type.

    \n
    • \n
  • \n

    \n vcpu-info.valid-cores - The number of cores that can be configured for the\n instance type.

    \n
    • \n
  • \n

    \n vcpu-info.valid-threads-per-core - The number of threads per core that can be\n configured for the instance type. For example, \"1\" or \"1,2\".

    \n
    • \n
", + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n
    \n
  • \n

    \n auto-recovery-supported - Indicates whether Amazon CloudWatch action\n based recovery is supported (true | false).

    \n
    • \n
  • \n

    \n bare-metal - Indicates whether it is a bare metal instance type\n (true | false).

    \n
    • \n
  • \n

    \n burstable-performance-supported - Indicates whether the instance type is a\n burstable performance T instance type (true | false).

    \n
    • \n
  • \n

    \n current-generation - Indicates whether this instance type is the latest\n generation instance type of an instance family (true | false).

    \n
    • \n
  • \n

    \n dedicated-hosts-supported - Indicates whether the instance type supports\n Dedicated Hosts. (true | false)

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline\n bandwidth performance for an EBS-optimized instance type, in Mbps.

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage\n operations per second for an EBS-optimized instance type.

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline\n throughput performance for an EBS-optimized instance type, in MB/s.

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth\n performance for an EBS-optimized instance type, in Mbps.

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage\n operations per second for an EBS-optimized instance type.

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum\n throughput performance for an EBS-optimized instance type, in MB/s.

    \n
    • \n
  • \n

    \n ebs-info.ebs-optimized-support - Indicates whether the instance type is\n EBS-optimized (supported | unsupported |\n default).

    \n
    • \n
  • \n

    \n ebs-info.encryption-support - Indicates whether EBS encryption is supported\n (supported | unsupported).

    \n
    • \n
  • \n

    \n ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)\n is supported for EBS volumes (required | supported |\n unsupported).

    \n
    • \n
  • \n

    \n free-tier-eligible - A Boolean that indicates whether this instance type can\n be used under the Amazon Web Services Free Tier (true | false).

    \n
    • \n
  • \n

    \n hibernation-supported - Indicates whether On-Demand hibernation is supported\n (true | false).

    \n
    • \n
  • \n

    \n hypervisor - The hypervisor (nitro | xen).

    \n
    • \n
  • \n

    \n instance-storage-info.disk.count - The number of local disks.

    \n
    • \n
  • \n

    \n instance-storage-info.disk.size-in-gb - The storage size of each instance\n storage disk, in GB.

    \n
    • \n
  • \n

    \n instance-storage-info.disk.type - The storage technology for the local\n instance storage disks (hdd | ssd).

    \n
    • \n
  • \n

    \n instance-storage-info.encryption-support - Indicates whether data is\n encrypted at rest (required | supported |\n unsupported).

    \n
    • \n
  • \n

    \n instance-storage-info.nvme-support - Indicates whether non-volatile memory\n express (NVMe) is supported for instance store (required | supported\n | unsupported).

    \n
    • \n
  • \n

    \n instance-storage-info.total-size-in-gb - The total amount of storage\n available from all local instance storage, in GB.

    \n
    • \n
  • \n

    \n instance-storage-supported - Indicates whether the instance type has local\n instance storage (true | false).

    \n
    • \n
  • \n

    \n instance-type - The instance type (for example c5.2xlarge or\n c5*).

    \n
    • \n
  • \n

    \n memory-info.size-in-mib - The memory size.

    \n
    • \n
  • \n

    \n network-info.bandwidth-weightings - For instances that support bandwidth\n weighting to boost performance (default, vpc-1,\n ebs-1).

    \n
    • \n
  • \n

    \n network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic\n Fabric Adapters (EFAs) per instance.

    \n
    • \n
  • \n

    \n network-info.efa-supported - Indicates whether the instance type supports\n Elastic Fabric Adapter (EFA) (true | false).

    \n
    • \n
  • \n

    \n network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is\n supported or required (required | supported |\n unsupported).

    \n
    • \n
  • \n

    \n network-info.flexible-ena-queues-support - Indicates whether an instance supports\n flexible ENA queues (supported | unsupported).

    \n
    • \n
  • \n

    \n network-info.encryption-in-transit-supported - Indicates whether the instance\n type automatically encrypts in-transit traffic between instances (true | false).

    \n
    • \n
  • \n

    \n network-info.ipv4-addresses-per-interface - The maximum number of private\n IPv4 addresses per network interface.

    \n
    • \n
  • \n

    \n network-info.ipv6-addresses-per-interface - The maximum number of private\n IPv6 addresses per network interface.

    \n
    • \n
  • \n

    \n network-info.ipv6-supported - Indicates whether the instance type supports\n IPv6 (true | false).

    \n
    • \n
  • \n

    \n network-info.maximum-network-cards - The maximum number of network cards per\n instance.

    \n
    • \n
  • \n

    \n network-info.maximum-network-interfaces - The maximum number of network\n interfaces per instance.

    \n
    • \n
  • \n

    \n network-info.network-performance - The network performance (for example, \"25\n Gigabit\").

    \n
    • \n
  • \n

    \n nitro-enclaves-support - Indicates whether Nitro Enclaves is supported\n (supported | unsupported).

    \n
    • \n
  • \n

    \n nitro-tpm-support - Indicates whether NitroTPM is supported\n (supported | unsupported).

    \n
    • \n
  • \n

    \n nitro-tpm-info.supported-versions - The supported NitroTPM version\n (2.0).

    \n
    • \n
  • \n

    \n processor-info.supported-architecture - The CPU architecture\n (arm64 | i386 | x86_64).

    \n
    • \n
  • \n

    \n processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in\n GHz.

    \n
    • \n
  • \n

    \n processor-info.supported-features - The supported CPU features\n (amd-sev-snp).

    \n
    • \n
  • \n

    \n reboot-migration-support - Indicates whether enabling reboot migration is\n supported (supported | unsupported).

    \n
    • \n
  • \n

    \n supported-boot-mode - The boot mode (legacy-bios |\n uefi).

    \n
    • \n
  • \n

    \n supported-root-device-type - The root device type (ebs |\n instance-store).

    \n
    • \n
  • \n

    \n supported-usage-class - The usage class (on-demand |\n spot | capacity-block).

    \n
    • \n
  • \n

    \n supported-virtualization-type - The virtualization type (hvm |\n paravirtual).

    \n
    • \n
  • \n

    \n vcpu-info.default-cores - The default number of cores for the instance\n type.

    \n
    • \n
  • \n

    \n vcpu-info.default-threads-per-core - The default number of threads per core\n for the instance type.

    \n
    • \n
  • \n

    \n vcpu-info.default-vcpus - The default number of vCPUs for the instance\n type.

    \n
    • \n
  • \n

    \n vcpu-info.valid-cores - The number of cores that can be configured for the\n instance type.

    \n
    • \n
  • \n

    \n vcpu-info.valid-threads-per-core - The number of threads per core that can be\n configured for the instance type. For example, \"1\" or \"1,2\".

    \n
    • \n
", "smithy.api#xmlName": "Filter" } }, @@ -38535,7 +38535,7 @@ "target": "com.amazonaws.ec2#DescribeManagedPrefixListsResult" }, "traits": { - "smithy.api#documentation": "

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

\n

To view the entries for your prefix list, use GetManagedPrefixListEntries.

", + "smithy.api#documentation": "

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -40018,7 +40018,7 @@ "target": "com.amazonaws.ec2#DescribePrefixListsResult" }, "traits": { - "smithy.api#documentation": "

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list\n name and prefix list ID of the service and the IP address range for the service.

\n

We recommend that you use DescribeManagedPrefixLists instead.

", + "smithy.api#documentation": "

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list\n name and prefix list ID of the service and the IP address range for the service.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -42153,7 +42153,7 @@ "target": "com.amazonaws.ec2#DescribeSnapshotsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified EBS snapshots available to you or all of the EBS snapshots\n available to you.

\n

The snapshots available to you include public snapshots, private snapshots that you own,\n and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume\n permissions.

\n

The create volume permissions fall into the following categories:

\n
    \n
  • \n

    \n public: The owner of the snapshot granted create volume\n permissions for the snapshot to the all group. All Amazon Web Services accounts have create\n volume permissions for these snapshots.

    \n
    • \n
  • \n

    \n explicit: The owner of the snapshot granted create volume\n permissions to a specific Amazon Web Services account.

    \n
    • \n
  • \n

    \n implicit: An Amazon Web Services account has implicit create volume permissions\n for all snapshots it owns.

    \n
    • \n
\n

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot\n owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, \n Amazon EC2 returns all snapshots for which you have create volume permissions.

\n

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a\n snapshot ID for which you do not have access, it is not included in the returned\n results.

\n

If you specify one or more snapshot owners using the OwnerIds option, only\n snapshots from the specified owners and for which you have access are returned. The results\n can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots\n owned by Amazon, or self for snapshots that you own.

\n

If you specify a list of restorable users, only snapshots with create snapshot permissions\n for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.

\n

If you are describing a long list of snapshots, we recommend that you paginate the output to make the\n list more manageable. For more information, see Pagination.

\n

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

\n

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n ", + "smithy.api#documentation": "

Describes the specified EBS snapshots available to you or all of the EBS snapshots\n available to you.

\n

The snapshots available to you include public snapshots, private snapshots that you own,\n and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume\n permissions.

\n

The create volume permissions fall into the following categories:

\n
    \n
  • \n

    \n public: The owner of the snapshot granted create volume\n permissions for the snapshot to the all group. All Amazon Web Services accounts have create\n volume permissions for these snapshots.

    \n
    • \n
  • \n

    \n explicit: The owner of the snapshot granted create volume\n permissions to a specific Amazon Web Services account.

    \n
    • \n
  • \n

    \n implicit: An Amazon Web Services account has implicit create volume permissions\n for all snapshots it owns.

    \n
    • \n
\n

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot\n owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, \n Amazon EC2 returns all snapshots for which you have create volume permissions.

\n

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a\n snapshot ID for which you do not have access, it is not included in the returned\n results.

\n

If you specify one or more snapshot owners using the OwnerIds option, only\n snapshots from the specified owners and for which you have access are returned. The results\n can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots\n owned by Amazon, or self for snapshots that you own.

\n

If you specify a list of restorable users, only snapshots with create snapshot permissions\n for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.

\n

If you are describing a long list of snapshots, we recommend that you paginate the output to make the\n list more manageable. For more information, see Pagination.

\n

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.

\n \n

We strongly recommend using only paginated requests. Unpaginated requests are\n susceptible to throttling and timeouts.

\n ", "smithy.api#examples": [ { "title": "To describe a snapshot", @@ -45466,7 +45466,7 @@ "target": "com.amazonaws.ec2#DescribeVolumeStatusResult" }, "traits": { - "smithy.api#documentation": "

Describes the status of the specified volumes. Volume status provides the result of the\n checks performed on your volumes to determine events that can impair the performance of your\n volumes. The performance of a volume can be affected if an issue occurs on the volume's\n underlying host. If the volume's underlying host experiences a power outage or system issue,\n after the system is restored, there could be data inconsistencies on the volume. Volume events\n notify you if this occurs. Volume actions notify you if any action needs to be taken in\n response to the event.

\n

The DescribeVolumeStatus operation provides the following information about\n the specified volumes:

\n

\n Status: Reflects the current status of the volume. The possible\n values are ok, impaired , warning, or\n insufficient-data. If all checks pass, the overall status of the volume is\n ok. If the check fails, the overall status is impaired. If the\n status is insufficient-data, then the checks might still be taking place on your\n volume at the time. We recommend that you retry the request. For more information about volume\n status, see Monitor the status of your volumes in the Amazon EBS User Guide.

\n

\n Events: Reflect the cause of a volume status and might require you to\n take action. For example, if your volume returns an impaired status, then the\n volume event might be potential-data-inconsistency. This means that your volume\n has been affected by an issue with the underlying host, has all I/O operations disabled, and\n might have inconsistent data.

\n

\n Actions: Reflect the actions you might have to take in response to an\n event. For example, if the status of the volume is impaired and the volume event\n shows potential-data-inconsistency, then the action shows\n enable-volume-io. This means that you may want to enable the I/O operations for\n the volume by calling the EnableVolumeIO action and then check the volume\n for data consistency.

\n

Volume status is based on the volume status checks, and does not reflect the volume state.\n Therefore, volume status does not indicate volumes in the error state (for\n example, when a volume is incapable of accepting I/O.)

\n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", + "smithy.api#documentation": "

Describes the status of the specified volumes. Volume status provides the result of the\n checks performed on your volumes to determine events that can impair the performance of your\n volumes. The performance of a volume can be affected if an issue occurs on the volume's\n underlying host. If the volume's underlying host experiences a power outage or system issue,\n after the system is restored, there could be data inconsistencies on the volume. Volume events\n notify you if this occurs. Volume actions notify you if any action needs to be taken in\n response to the event.

\n

The DescribeVolumeStatus operation provides the following information about\n the specified volumes:

\n

\n Status: Reflects the current status of the volume. The possible\n values are ok, impaired , warning, or\n insufficient-data. If all checks pass, the overall status of the volume is\n ok. If the check fails, the overall status is impaired. If the\n status is insufficient-data, then the checks might still be taking place on your\n volume at the time. We recommend that you retry the request. For more information about volume\n status, see Monitor the status of your volumes in the Amazon EBS User Guide.

\n

\n Events: Reflect the cause of a volume status and might require you to\n take action. For example, if your volume returns an impaired status, then the\n volume event might be potential-data-inconsistency. This means that your volume\n has been affected by an issue with the underlying host, has all I/O operations disabled, and\n might have inconsistent data.

\n

\n Actions: Reflect the actions you might have to take in response to an\n event. For example, if the status of the volume is impaired and the volume event\n shows potential-data-inconsistency, then the action shows\n enable-volume-io. This means that you may want to enable the I/O operations for\n the volume and then check the volume for data consistency. For more information, see \n Work with an \n impaired EBS volume.

\n

Volume status is based on the volume status checks, and does not reflect the volume state.\n Therefore, volume status does not indicate volumes in the error state (for\n example, when a volume is incapable of accepting I/O.)

\n \n

The order of the elements in the response, including those within nested\n structures, might vary. Applications should not assume the elements appear in a\n particular order.

\n ", "smithy.api#examples": [ { "title": "To describe the status of a single volume", @@ -50750,7 +50750,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone where the EBS volume will be created (for example,\n us-east-1a).

\n

Either AvailabilityZone or AvailabilityZoneId can be specified,\n but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within\n the Region.

\n

This parameter is not supported when using \n CreateImage, \n DescribeImages, and \n RunInstances.

", + "smithy.api#documentation": "

The Availability Zone where the EBS volume will be created (for example,\n us-east-1a).

\n

Either AvailabilityZone or AvailabilityZoneId can be specified,\n but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within\n the Region.

\n

This parameter is not supported when using \n CreateFleet, \n CreateImage, \n DescribeImages, \n RequestSpotFleet, \n RequestSpotInstances, and \n RunInstances.

", "smithy.api#xmlName": "availabilityZone" } }, @@ -50771,7 +50771,7 @@ "AvailabilityZoneId": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of the Availability Zone where the EBS volume will be created (for example,\n use1-az1).

\n

Either AvailabilityZone or AvailabilityZoneId can be specified,\n but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within\n the Region.

\n

This parameter is not supported when using \n CreateImage, \n DescribeImages, and \n RunInstances.

" + "smithy.api#documentation": "

The ID of the Availability Zone where the EBS volume will be created (for example,\n use1-az1).

\n

Either AvailabilityZone or AvailabilityZoneId can be specified,\n but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within\n the Region.

\n

This parameter is not supported when using \n CreateFleet, \n CreateImage, \n DescribeImages, \n RequestSpotFleet, \n RequestSpotInstances, and \n RunInstances.

" } } }, @@ -52069,7 +52069,7 @@ "target": "com.amazonaws.ec2#EnableEbsEncryptionByDefaultResult" }, "traits": { - "smithy.api#documentation": "

Enables EBS encryption by default for your account in the current Region.

\n

After you enable encryption by default, the EBS volumes that you create are\n \talways encrypted, either using the default KMS key or the KMS key that you specified\n when you created each volume. For more information, see Amazon EBS encryption in the\n Amazon EBS User Guide.

\n

You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId\n or ResetEbsDefaultKmsKeyId.

\n

Enabling encryption by default has no effect on the encryption status of your \n existing volumes.

\n

After you enable encryption by default, you can no longer launch instances\n using instance types that do not support encryption. For more information, see Supported\n instance types.

" + "smithy.api#documentation": "

Enables EBS encryption by default for your account in the current Region.

\n

After you enable encryption by default, the EBS volumes that you create are\n \talways encrypted, either using the default KMS key or the KMS key that you specified\n when you created each volume. For more information, see Amazon EBS encryption in the\n Amazon EBS User Guide.

\n

Enabling encryption by default has no effect on the encryption status of your \n existing volumes.

\n

After you enable encryption by default, you can no longer launch instances\n using instance types that do not support encryption. For more information, see Supported\n instance types.

" } }, "com.amazonaws.ec2#EnableEbsEncryptionByDefaultRequest": { @@ -52444,7 +52444,7 @@ "target": "com.amazonaws.ec2#EnableFastSnapshotRestoresResult" }, "traits": { - "smithy.api#documentation": "

Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.

\n

You get the full benefit of fast snapshot restores after they enter the enabled state.\n To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores.\n To disable fast snapshot restores, use DisableFastSnapshotRestores.

\n

For more information, see Amazon EBS fast snapshot\n restore in the Amazon EBS User Guide.

" + "smithy.api#documentation": "

Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.

\n

You get the full benefit of fast snapshot restores after they enter the enabled state.

\n

For more information, see Amazon EBS fast snapshot\n restore in the Amazon EBS User Guide.

" } }, "com.amazonaws.ec2#EnableFastSnapshotRestoresRequest": { @@ -52632,7 +52632,7 @@ "target": "com.amazonaws.ec2#EnableImageDeregistrationProtectionResult" }, "traits": { - "smithy.api#documentation": "

Enables deregistration protection for an AMI. When deregistration protection is enabled,\n the AMI can't be deregistered.

\n

To allow the AMI to be deregistered, you must first disable deregistration protection\n using DisableImageDeregistrationProtection.

\n

For more information, see Protect an\n Amazon EC2 AMI from deregistration in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Enables deregistration protection for an AMI. When deregistration protection is enabled,\n the AMI can't be deregistered.

\n

To allow the AMI to be deregistered, you must first disable deregistration protection.

\n

For more information, see Protect an\n Amazon EC2 AMI from deregistration in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#EnableImageDeregistrationProtectionRequest": { @@ -55793,7 +55793,7 @@ } }, "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#AvailabilityZoneName", "traits": { "aws.protocols#ec2QueryName": "AvailabilityZone", "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

", @@ -55893,7 +55893,7 @@ } }, "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#AvailabilityZoneName", "traits": { "smithy.api#documentation": "

The Availability Zone in which to launch the instances.

" } @@ -57712,7 +57712,7 @@ "target": "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdResult" }, "traits": { - "smithy.api#documentation": "

Describes the default KMS key for EBS encryption by default for your account in this Region. \n \t\tYou can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or\n ResetEbsDefaultKmsKeyId.

\n

For more information, see Amazon EBS encryption\n in the Amazon EBS User Guide.

" + "smithy.api#documentation": "

Describes the default KMS key for EBS encryption by default for your account in this Region.

\n

For more information, see Amazon EBS encryption\n in the Amazon EBS User Guide.

" } }, "com.amazonaws.ec2#GetEbsDefaultKmsKeyIdRequest": { @@ -62588,7 +62588,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SourceImageId", - "smithy.api#documentation": "

The ID of the source AMI from which the AMI was created.

\n

The ID only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The ID does not appear\n if the AMI was created using any other API. For some older AMIs, the ID might not be\n available. For more information, see Identify the\n source AMI used to create a new Amazon EC2 AMI in the\n Amazon EC2 User Guide.

", + "smithy.api#documentation": "

The ID of the source AMI from which the AMI was created.

", "smithy.api#xmlName": "sourceImageId" } }, @@ -62596,10 +62596,18 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "SourceImageRegion", - "smithy.api#documentation": "

The Region of the source AMI.

\n

The Region only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The Region does not\n appear if the AMI was created using any other API. For some older AMIs, the Region might not\n be available. For more information, see Identify the\n source AMI used to create a new Amazon EC2 AMI in the\n Amazon EC2 User Guide.

", + "smithy.api#documentation": "

The Region of the source AMI.

", "smithy.api#xmlName": "sourceImageRegion" } }, + "FreeTierEligible": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "FreeTierEligible", + "smithy.api#documentation": "

Indicates whether the image is eligible for Amazon Web Services Free Tier.

\n
    \n
  • \n

    If true, the AMI is eligible for Free Tier and can be used to launch\n instances under the Free Tier limits.

    \n
    • \n
  • \n

    If false, the AMI is not eligible for Free Tier.

    \n
    • \n
", + "smithy.api#xmlName": "freeTierEligible" + } + }, "ImageId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -73973,6 +73981,90 @@ "traits": { "smithy.api#enumValue": "r8gd.metal-48xl" } + }, + "c8gn_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gn.medium" + } + }, + "c8gn_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gn.large" + } + }, + "c8gn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gn.xlarge" + } + }, + "c8gn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gn.2xlarge" + } + }, + "c8gn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gn.4xlarge" + } + }, + "c8gn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gn.8xlarge" + } + }, + "c8gn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gn.12xlarge" + } + }, + "c8gn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gn.16xlarge" + } + }, + "c8gn_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gn.24xlarge" + } + }, + "c8gn_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gn.48xlarge" + } + }, + "c8gn_metal_24xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gn.metal-24xl" + } + }, + "c8gn_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c8gn.metal-48xl" + } + }, + "f2_6xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "f2.6xlarge" + } + }, + "p6e_gb200_36xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "p6e-gb200.36xlarge" + } } } }, @@ -83375,7 +83467,7 @@ "target": "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdResult" }, "traits": { - "smithy.api#documentation": "

Changes the default KMS key for EBS encryption by default for your account in this Region.

\n

Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If\n you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services\n managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.

\n

If you delete or disable the customer managed KMS key that you specified for use with\n encryption by default, your instances will fail to launch.

\n

For more information, see Amazon EBS encryption\n in the Amazon EBS User Guide.

" + "smithy.api#documentation": "

Changes the default KMS key for EBS encryption by default for your account in this Region.

\n

Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If\n you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services\n managed KMS key. Amazon EBS does not support asymmetric KMS keys.

\n

If you delete or disable the customer managed KMS key that you specified for use with\n encryption by default, your instances will fail to launch.

\n

For more information, see Amazon EBS encryption\n in the Amazon EBS User Guide.

" } }, "com.amazonaws.ec2#ModifyEbsDefaultKmsKeyIdRequest": { @@ -89099,7 +89191,7 @@ "target": "com.amazonaws.ec2#MoveAddressToVpcResult" }, "traits": { - "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The\n Elastic IP address must be allocated to your account for more than 24 hours, and it must not\n be associated with an instance. After the Elastic IP address is moved, it is no longer\n available for use in the EC2-Classic platform, unless you move it back using the\n RestoreAddressToClassic request. You cannot move an Elastic IP address that was\n originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

", + "smithy.api#documentation": "\n

This action is deprecated.

\n \n

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The\n Elastic IP address must be allocated to your account for more than 24 hours, and it must not\n be associated with an instance. After the Elastic IP address is moved, it is no longer\n available for use in the EC2-Classic platform. You cannot move an Elastic IP address that was\n originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

", "smithy.api#examples": [ { "title": "To move an address to EC2-VPC", @@ -94670,7 +94762,7 @@ "target": "com.amazonaws.ec2#ProvisionByoipCidrResult" }, "traits": { - "smithy.api#documentation": "

Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP \n addresses (BYOIP) and creates a corresponding address pool. After the address range is\n provisioned, it is ready to be advertised using AdvertiseByoipCidr.

\n

Amazon Web Services verifies that you own the address range and are authorized to advertise it. \n You must ensure that the address range is registered to you and that you created an \n RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. \n For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.

\n

Provisioning an address range is an asynchronous operation, so the call returns immediately,\n but the address range is not ready to use until its status changes from pending-provision\n to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. \n To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress \n with either the specific address from the address pool or the ID of the address pool.

" + "smithy.api#documentation": "

Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP \n addresses (BYOIP) and creates a corresponding address pool. After the address range is\n provisioned, it is ready to be advertised.

\n

Amazon Web Services verifies that you own the address range and are authorized to advertise it. \n You must ensure that the address range is registered to you and that you created an \n RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. \n For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.

\n

Provisioning an address range is an asynchronous operation, so the call returns immediately,\n but the address range is not ready to use until its status changes from pending-provision\n to provisioned. For more information, see Onboard your address range.

" } }, "com.amazonaws.ec2#ProvisionByoipCidrRequest": { @@ -96091,7 +96183,7 @@ "target": "com.amazonaws.ec2#RegisterImageResult" }, "traits": { - "smithy.api#documentation": "

Registers an AMI. When you're creating an instance-store backed AMI, registering the AMI\n is the final step in the creation process. For more information about creating AMIs, see\n Create an AMI from a snapshot and Create an instance-store\n backed AMI in the Amazon EC2 User Guide.

\n \n

For Amazon EBS-backed instances, CreateImage creates and registers the AMI\n in a single request, so you don't have to register the AMI yourself. We recommend that you\n always use CreateImage unless you have a specific reason to use\n RegisterImage.

\n \n

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI\n backed by an instance store volume invalidates its registration. If you make changes to an\n image, deregister the previous image and register the new image.

\n

\n Register a snapshot of a root device volume\n

\n

You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot\n of a root device volume. You specify the snapshot using a block device mapping. You can't set\n the encryption state of the volume using the block device mapping. If the snapshot is\n encrypted, or encryption by default is enabled, the root volume of an instance launched from\n the AMI is encrypted.

\n

For more information, see Create an AMI from a snapshot and Use encryption with EBS-backed AMIs\n in the Amazon EC2 User Guide.

\n

\n Amazon Web Services Marketplace product codes\n

\n

If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.

\n

In most cases, AMIs for Windows, RedHat, SUSE, and SQL Server require correct licensing\n information to be present on the AMI. For more information, see Understand AMI billing\n information in the Amazon EC2 User Guide. When creating an AMI from\n a snapshot, the RegisterImage operation derives the correct billing information\n from the snapshot's metadata, but this requires the appropriate metadata to be present. To\n verify if the correct billing information was applied, check the PlatformDetails\n field on the new AMI. If the field is empty or doesn't match the expected operating system\n code (for example, Windows, RedHat, SUSE, or SQL), the AMI creation was unsuccessful, and you\n should discard the AMI and instead create the AMI from an instance using CreateImage. For more information, see Create an AMI\n from an instance in the Amazon EC2 User Guide.

\n

If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched\n from an AMI with a billing product code, make sure that the Reserved Instance has the matching\n billing product code. If you purchase a Reserved Instance without the matching billing product\n code, the Reserved Instance will not be applied to the On-Demand Instance. For information\n about how to obtain the platform details and billing information of an AMI, see Understand AMI\n billing information in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Registers an AMI. When you're creating an instance-store backed AMI, registering the AMI\n is the final step in the creation process. For more information about creating AMIs, see\n Create an AMI from a snapshot and Create an instance-store\n backed AMI in the Amazon EC2 User Guide.

\n

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI\n backed by an instance store volume invalidates its registration. If you make changes to an\n image, deregister the previous image and register the new image.

\n

\n Register a snapshot of a root device volume\n

\n

You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot\n of a root device volume. You specify the snapshot using a block device mapping. You can't set\n the encryption state of the volume using the block device mapping. If the snapshot is\n encrypted, or encryption by default is enabled, the root volume of an instance launched from\n the AMI is encrypted.

\n

For more information, see Create an AMI from a snapshot and Use encryption with EBS-backed AMIs\n in the Amazon EC2 User Guide.

\n

\n Amazon Web Services Marketplace product codes\n

\n

If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.

\n

In most cases, AMIs for Windows, RedHat, SUSE, and SQL Server require correct licensing\n information to be present on the AMI. For more information, see Understand AMI billing\n information in the Amazon EC2 User Guide. When creating an AMI from\n a snapshot, the RegisterImage operation derives the correct billing information\n from the snapshot's metadata, but this requires the appropriate metadata to be present. To\n verify if the correct billing information was applied, check the PlatformDetails\n field on the new AMI. If the field is empty or doesn't match the expected operating system\n code (for example, Windows, RedHat, SUSE, or SQL), the AMI creation was unsuccessful, and you\n should discard the AMI and instead create the AMI from an instance. \n For more information, see Create an AMI\n from an instance in the Amazon EC2 User Guide.

\n

If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched\n from an AMI with a billing product code, make sure that the Reserved Instance has the matching\n billing product code. If you purchase a Reserved Instance without the matching billing product\n code, the Reserved Instance is not applied to the On-Demand Instance. For information\n about how to obtain the platform details and billing information of an AMI, see Understand AMI\n billing information in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#RegisterImageRequest": { @@ -96784,7 +96876,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Releases the specified Elastic IP address.

\n

[Default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. To disassociate an Elastic IP address without\n\t\t\t\treleasing it, use DisassociateAddress.

\n

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address\n\t\t\t before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

\n

After releasing an Elastic IP address, it is released to the IP address pool. \n Be sure to update your DNS records and any servers or devices that communicate with the address. \n If you attempt to release an Elastic IP address that you already released, you'll get an\n AuthFailure error if the address is already allocated to another Amazon Web Services account.

\n

After you release an Elastic IP address, you might be able to recover it.\n For more information, see AllocateAddress.

", + "smithy.api#documentation": "

Releases the specified Elastic IP address.

\n

[Default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. Alternatively, you can disassociate an Elastic IP address without\n\t\t\t\treleasing it.

\n

[Nondefault VPC] You must disassociate the Elastic IP address\n\t\t\t before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

\n

After releasing an Elastic IP address, it is released to the IP address pool. \n Be sure to update your DNS records and any servers or devices that communicate with the address. \n If you attempt to release an Elastic IP address that you already released, you'll get an\n AuthFailure error if the address is already allocated to another Amazon Web Services account.

\n

After you release an Elastic IP address, you might be able to recover it.\n For more information, see Release an Elastic IP address.

", "smithy.api#examples": [ { "title": "To release an Elastic IP address", @@ -102205,6 +102297,14 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ODB network.

", "smithy.api#xmlName": "odbNetworkArn" } + }, + "IpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpAddress", + "smithy.api#documentation": "

The next hop IP address for routes propagated by VPC Route \n Server into VPC route tables.

", + "smithy.api#xmlName": "ipAddress" + } } }, "traits": { @@ -103612,7 +103712,7 @@ "InstanceType": { "target": "com.amazonaws.ec2#InstanceType", "traits": { - "smithy.api#documentation": "

The instance type. For more information, see Amazon EC2 instance\n types in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

The instance type. For more information, see Amazon EC2 Instance\n Types Guide.

" } }, "Ipv6AddressCount": { @@ -103637,7 +103737,7 @@ "KeyName": { "target": "com.amazonaws.ec2#KeyPairName", "traits": { - "smithy.api#documentation": "

The name of the key pair. You can create a key pair using CreateKeyPair or\n ImportKeyPair.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " + "smithy.api#documentation": "

The name of the key pair. For more information, see Create a key pair for your EC2 instance.

\n \n

If you do not specify a key pair, you can't connect to the instance unless you\n choose an AMI that is configured to allow users another way to log in.

\n " } }, "MaxCount": { @@ -103677,7 +103777,7 @@ "SecurityGroupIds": { "target": "com.amazonaws.ec2#SecurityGroupIdStringList", "traits": { - "smithy.api#documentation": "

The IDs of the security groups. You can create a security group using CreateSecurityGroup.

\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#documentation": "

The IDs of 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": "SecurityGroupId" } }, @@ -103697,7 +103797,7 @@ "UserData": { "target": "com.amazonaws.ec2#RunInstancesUserData", "traits": { - "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.

" + "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 Run commands at launch using instance user data.

" } }, "ElasticGpuSpecification": { @@ -103766,13 +103866,13 @@ "MetadataOptions": { "target": "com.amazonaws.ec2#InstanceMetadataOptionsRequest", "traits": { - "smithy.api#documentation": "

The metadata options for the instance. For more information, see Instance metadata and user data.

" + "smithy.api#documentation": "

The metadata options for the instance. For more information, see Configure the Instance Metadata Service options.

" } }, "EnclaveOptions": { "target": "com.amazonaws.ec2#EnclaveOptionsRequest", "traits": { - "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For\n more information, see What is Amazon Web Services Nitro\n Enclaves? in the Amazon Web Services Nitro Enclaves User\n Guide.

\n

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same\n instance.

" + "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For\n more information, see Amazon Web Services Nitro\n Enclaves User Guide.

\n

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same\n instance.

" } }, "PrivateDnsNameOptions": { @@ -103790,7 +103890,7 @@ "DisableApiStop": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether an instance is enabled for stop protection. For more information,\n see Stop\n protection.

" + "smithy.api#documentation": "

Indicates whether an instance is enabled for stop protection. For more information,\n see Enable stop protection for your EC2 instances.

" } }, "EnablePrimaryIpv6": { @@ -103847,7 +103947,7 @@ "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#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 idempotency in Amazon EC2 API requests.

\n

Constraints: Maximum 64 ASCII characters

", "smithy.api#idempotencyToken": {}, "smithy.api#xmlName": "clientToken" } @@ -106533,7 +106633,7 @@ "target": "com.amazonaws.ec2#String", "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#documentation": "

The ID of the volume that was used to create the snapshot. Snapshots created by a copy\n snapshot operation have an arbitrary volume ID that you should not use for any purpose.

", "smithy.api#xmlName": "volumeId" } }, @@ -108705,7 +108805,7 @@ "target": "com.amazonaws.ec2#StartDeclarativePoliciesReportResult" }, "traits": { - "smithy.api#documentation": "

Generates an account status report. The report is generated asynchronously, and can\n take several hours to complete.

\n

The report provides the current status of all attributes supported by declarative\n policies for the accounts within the specified scope. The scope is determined by the\n specified TargetId, which can represent an individual account, or all the\n accounts that fall under the specified organizational unit (OU) or root (the entire\n Amazon Web Services Organization).

\n

The report is saved to your specified S3 bucket, using the following path structure\n (with the italicized placeholders representing your specific\n values):

\n

\n s3://amzn-s3-demo-bucket/your-optional-s3-prefix/ec2_targetId_reportId_yyyyMMddThhmmZ.csv\n

\n

\n Prerequisites for generating a report\n

\n
    \n
  • \n

    The StartDeclarativePoliciesReport API can only be called by the\n management account or delegated administrators for the organization.

    \n
    • \n
  • \n

    An S3 bucket must be available before generating the report (you can create a\n new one or use an existing one), it must be in the same Region where the report\n generation request is made, and it must have an appropriate bucket policy. For a\n sample S3 policy, see Sample Amazon S3 policy under Examples.

    \n
    • \n
  • \n

    Trusted access must be enabled for the service for which the declarative\n policy will enforce a baseline configuration. If you use the Amazon Web Services Organizations\n console, this is done automatically when you enable declarative policies. The\n API uses the following service principal to identify the EC2 service:\n ec2.amazonaws.com. For more information on how to enable\n trusted access with the Amazon Web Services CLI and Amazon Web Services SDKs, see Using\n Organizations with other Amazon Web Services services in the\n Amazon Web Services Organizations User Guide.

    \n
    • \n
  • \n

    Only one report per organization can be generated at a time. Attempting to\n generate a report while another is in progress will result in an error.

    \n
    • \n
\n

For more information, including the required IAM permissions to run this API, see\n Generating the account status report for declarative policies in the\n Amazon Web Services Organizations User Guide.

" + "smithy.api#documentation": "

Generates an account status report. The report is generated asynchronously, and can\n take several hours to complete.

\n

The report provides the current status of all attributes supported by declarative\n policies for the accounts within the specified scope. The scope is determined by the\n specified TargetId, which can represent an individual account, or all the\n accounts that fall under the specified organizational unit (OU) or root (the entire\n Amazon Web Services Organization).

\n

The report is saved to your specified S3 bucket, using the following path structure\n (with the capitalized placeholders representing your specific values):

\n

\n s3://AMZN-S3-DEMO-BUCKET/YOUR-OPTIONAL-S3-PREFIX/ec2_TARGETID_REPORTID_YYYYMMDDTHHMMZ.csv\n

\n

\n Prerequisites for generating a report\n

\n
    \n
  • \n

    The StartDeclarativePoliciesReport API can only be called by the\n management account or delegated administrators for the organization.

    \n
    • \n
  • \n

    An S3 bucket must be available before generating the report (you can create a\n new one or use an existing one), it must be in the same Region where the report\n generation request is made, and it must have an appropriate bucket policy. For a\n sample S3 policy, see Sample Amazon S3 policy under Examples.

    \n
    • \n
  • \n

    Trusted access must be enabled for the service for which the declarative\n policy will enforce a baseline configuration. If you use the Amazon Web Services Organizations\n console, this is done automatically when you enable declarative policies. The\n API uses the following service principal to identify the EC2 service:\n ec2.amazonaws.com. For more information on how to enable\n trusted access with the Amazon Web Services CLI and Amazon Web Services SDKs, see Using\n Organizations with other Amazon Web Services services in the\n Amazon Web Services Organizations User Guide.

    \n
    • \n
  • \n

    Only one report per organization can be generated at a time. Attempting to\n generate a report while another is in progress will result in an error.

    \n
    • \n
\n

For more information, including the required IAM permissions to run this API, see\n Generating the account status report for declarative policies in the\n Amazon Web Services Organizations User Guide.

" } }, "com.amazonaws.ec2#StartDeclarativePoliciesReportRequest": { @@ -109240,7 +109340,7 @@ "target": "com.amazonaws.ec2#StopInstancesResult" }, "traits": { - "smithy.api#documentation": "

Stops an Amazon EBS-backed instance. You can restart your instance at any time using\n the StartInstances API. For more information, see Stop and start Amazon EC2\n instances in the Amazon EC2 User Guide.

\n

When you stop an instance, we shut it down.

\n

You can use the Stop operation together with the Hibernate parameter to hibernate an\n instance if the instance is enabled for\n hibernation and meets the hibernation\n prerequisites. Stopping an instance doesn't preserve data stored in RAM,\n while hibernation does. If hibernation fails, a normal shutdown occurs. For more\n information, see Hibernate your Amazon EC2\n instance in the Amazon EC2 User Guide.

\n

If your instance appears stuck in the stopping state, there might be an\n issue with the underlying host computer. You can use the Stop operation together with\n the Force parameter to force stop your instance. For more information, see Troubleshoot\n Amazon EC2 instance stop issues in the\n Amazon EC2 User Guide.

\n

Stopping and hibernating an instance differs from rebooting or terminating it. For\n example, a stopped or hibernated instance retains its root volume and any data volumes,\n unlike terminated instances where these volumes are automatically deleted. For more\n information about the differences between stopping, hibernating, rebooting, and\n terminating instances, see Amazon EC2\n instance state changes in the Amazon EC2 User Guide.

\n

We don't charge for instance usage or data transfer fees when an instance is stopped.\n However, the root volume and any data volumes remain and continue to persist your data,\n and you're charged for volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, followed by per-second\n billing.

\n

You can't stop or hibernate instance store-backed instances.

", + "smithy.api#documentation": "

Stops an Amazon EBS-backed instance. You can restart your instance at any time using\n the StartInstances API. For more information, see Stop and start Amazon EC2\n instances in the Amazon EC2 User Guide.

\n

When you stop or hibernate an instance, we shut it down. By default, this includes a\n graceful operating system (OS) shutdown. To bypass the graceful shutdown, use the\n skipOsShutdown parameter; however, this might risk data\n integrity.

\n

You can use the StopInstances operation together with the Hibernate\n parameter to hibernate an instance if the instance is enabled for\n hibernation and meets the hibernation\n prerequisites. Stopping an instance doesn't preserve data stored in RAM,\n while hibernation does. If hibernation fails, a normal shutdown occurs. For more\n information, see Hibernate your Amazon EC2\n instance in the Amazon EC2 User Guide.

\n

If your instance appears stuck in the stopping state, there might be an\n issue with the underlying host computer. You can use the StopInstances operation\n together with the Force parameter to force stop your instance. For more information, see\n Troubleshoot\n Amazon EC2 instance stop issues in the\n Amazon EC2 User Guide.

\n

Stopping and hibernating an instance differs from rebooting or terminating it. For\n example, a stopped or hibernated instance retains its root volume and any data volumes,\n unlike terminated instances where these volumes are automatically deleted. For more\n information about the differences between stopping, hibernating, rebooting, and\n terminating instances, see Amazon EC2\n instance state changes in the Amazon EC2 User Guide.

\n

We don't charge for instance usage or data transfer fees when an instance is stopped.\n However, the root volume and any data volumes remain and continue to persist your data,\n and you're charged for volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, followed by per-second\n billing.

\n

You can't stop or hibernate instance store-backed instances.

", "smithy.api#examples": [ { "title": "To stop a running EC2 instance", @@ -109284,7 +109384,13 @@ "Hibernate": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Hibernates the instance if the instance was enabled for hibernation at launch. If the\n instance cannot hibernate successfully, a normal shutdown occurs. For more information,\n see Hibernate\n your instance in the Amazon EC2 User Guide.

\n

Default: false\n

" + "smithy.api#documentation": "

Hibernates the instance if the instance was enabled for hibernation at launch. If the\n instance cannot hibernate successfully, a normal shutdown occurs. For more information,\n see Hibernate\n your Amazon EC2 instance in the\n Amazon EC2 User Guide.

\n

Default: false\n

" + } + }, + "SkipOsShutdown": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to bypass the graceful OS shutdown process when the instance is\n stopped.

\n \n

Bypassing the graceful OS shutdown might result in data loss or corruption (for\n example, memory contents not flushed to disk or loss of in-flight IOs) or skipped\n shutdown scripts.

\n \n

Default: false\n

" } }, "DryRun": { @@ -110863,7 +110969,7 @@ "target": "com.amazonaws.ec2#TerminateInstancesResult" }, "traits": { - "smithy.api#documentation": "

Shuts down the specified instances. This operation is idempotent; if you\n terminate an instance more than once, each call succeeds.

\n

If you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.

\n

If you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:

\n
    \n
  • \n

    The specified instances that are in the same Availability Zone as the\n protected instance are not terminated.

    \n
    • \n
  • \n

    The specified instances that are in different Availability Zones, where no\n other specified instances are protected, are successfully terminated.

    \n
    • \n
\n

For example, say you have the following instances:

\n
    \n
  • \n

    Instance A: us-east-1a; Not protected

    \n
    • \n
  • \n

    Instance B: us-east-1a; Not protected

    \n
    • \n
  • \n

    Instance C: us-east-1b; Protected

    \n
    • \n
  • \n

    Instance D: us-east-1b; not protected

    \n
    • \n
\n

If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:

\n
    \n
  • \n

    Instance A and Instance B are successfully terminated because none of the\n specified instances in us-east-1a are enabled for termination\n protection.

    \n
    • \n
  • \n

    Instance C and Instance D fail to terminate because at least one of the\n specified instances in us-east-1b (Instance C) is enabled for\n termination protection.

    \n
    • \n
\n

Terminated instances remain visible after termination (for approximately one\n hour).

\n

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

For more information about troubleshooting, see Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.

", + "smithy.api#documentation": "

Shuts down the specified instances. This operation is idempotent; if you\n terminate an instance more than once, each call succeeds.

\n

If you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.

\n

If you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:

\n
    \n
  • \n

    The specified instances that are in the same Availability Zone as the\n protected instance are not terminated.

    \n
    • \n
  • \n

    The specified instances that are in different Availability Zones, where no\n other specified instances are protected, are successfully terminated.

    \n
    • \n
\n

For example, say you have the following instances:

\n
    \n
  • \n

    Instance A: us-east-1a; Not protected

    \n
    • \n
  • \n

    Instance B: us-east-1a; Not protected

    \n
    • \n
  • \n

    Instance C: us-east-1b; Protected

    \n
    • \n
  • \n

    Instance D: us-east-1b; not protected

    \n
    • \n
\n

If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:

\n
    \n
  • \n

    Instance A and Instance B are successfully terminated because none of the\n specified instances in us-east-1a are enabled for termination\n protection.

    \n
    • \n
  • \n

    Instance C and Instance D fail to terminate because at least one of the\n specified instances in us-east-1b (Instance C) is enabled for\n termination protection.

    \n
    • \n
\n

Terminated instances remain visible after termination (for approximately one\n hour).

\n

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.

\n

By default, the TerminateInstances operation includes a graceful operating system (OS)\n shutdown. To bypass the graceful shutdown, use the skipOsShutdown\n parameter; however, this might risk data integrity.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Amazon EC2\n instance state changes in the Amazon EC2 User Guide.

\n

When you terminate an instance, we attempt to terminate it forcibly after a short\n while. If your instance appears stuck in the shutting-down state after a period of time,\n there might be an issue with the underlying host computer. For more information about\n terminating and troubleshooting terminating your instances, see Terminate Amazon EC2 instances and\n Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.

", "smithy.api#examples": [ { "title": "To terminate an EC2 instance", @@ -110904,6 +111010,18 @@ "smithy.api#xmlName": "InstanceId" } }, + "Force": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Forces the instances to terminate. The instance will first attempt a graceful\n shutdown, which includes flushing file system caches and metadata. If the graceful\n shutdown fails to complete within the timeout period, the instance shuts down forcibly\n without flushing the file system caches and metadata.

" + } + }, + "SkipOsShutdown": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to bypass the graceful OS shutdown process when the instance is\n terminated.

\n

Default: false\n

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -112187,6 +112305,12 @@ "traits": { "smithy.api#enumValue": "tgw-peering" } + }, + "network_function": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "network-function" + } } } }, diff --git a/codegen/sdk/aws-models/ecr.json b/codegen/sdk/aws-models/ecr.json index e2705943b1c..b52f81862fd 100644 --- a/codegen/sdk/aws-models/ecr.json +++ b/codegen/sdk/aws-models/ecr.json @@ -2866,6 +2866,12 @@ "smithy.api#documentation": "

The tag mutability setting for the repository. If this parameter is omitted, the\n default setting of MUTABLE will be used which will allow image tags to be\n overwritten. If IMMUTABLE is specified, all image tags within the\n repository will be immutable which will prevent them from being overwritten.

" } }, + "imageTagMutabilityExclusionFilters": { + "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilters", + "traits": { + "smithy.api#documentation": "

Creates a repository creation template with a list of filters that define which image tags can override the default image tag mutability setting.

" + } + }, "repositoryPolicy": { "target": "com.amazonaws.ecr#RepositoryPolicyText", "traits": { @@ -2944,6 +2950,12 @@ "smithy.api#documentation": "

The tag mutability setting for the repository. If this parameter is omitted, the\n default setting of MUTABLE will be used which will allow image tags to be\n overwritten. If IMMUTABLE is specified, all image tags within the\n repository will be immutable which will prevent them from being overwritten.

" } }, + "imageTagMutabilityExclusionFilters": { + "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilters", + "traits": { + "smithy.api#documentation": "

Creates a repository with a list of filters that define which image tags can override the default image tag mutability setting.

" + } + }, "imageScanningConfiguration": { "target": "com.amazonaws.ecr#ImageScanningConfiguration", "traits": { @@ -5704,6 +5716,73 @@ "traits": { "smithy.api#enumValue": "IMMUTABLE" } + }, + "IMMUTABLE_WITH_EXCLUSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMMUTABLE_WITH_EXCLUSION" + } + }, + "MUTABLE_WITH_EXCLUSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MUTABLE_WITH_EXCLUSION" + } + } + } + }, + "com.amazonaws.ecr#ImageTagMutabilityExclusionFilter": { + "type": "structure", + "members": { + "filterType": { + "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilterType", + "traits": { + "smithy.api#documentation": "

Specifies the type of filter to use for excluding image tags from the repository's mutability setting.

", + "smithy.api#required": {} + } + }, + "filter": { + "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilterValue", + "traits": { + "smithy.api#documentation": "

The value to use when filtering image tags. Must be either a regular expression pattern or a tag prefix value based on the specified filter type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Overrides the default image tag mutability setting of the repository for image tags that match the specified filters.

" + } + }, + "com.amazonaws.ecr#ImageTagMutabilityExclusionFilterType": { + "type": "enum", + "members": { + "WILDCARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WILDCARD" + } + } + } + }, + "com.amazonaws.ecr#ImageTagMutabilityExclusionFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._*-]{1,128}$" + } + }, + "com.amazonaws.ecr#ImageTagMutabilityExclusionFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 } } }, @@ -7047,6 +7126,12 @@ "smithy.api#documentation": "

The tag mutability setting for the repository. If MUTABLE is specified,\n image tags can be overwritten. If IMMUTABLE is specified, all image tags\n within the repository will be immutable which will prevent them from being\n overwritten.

", "smithy.api#required": {} } + }, + "imageTagMutabilityExclusionFilters": { + "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilters", + "traits": { + "smithy.api#documentation": "

Creates or updates a repository with filters that define which image tags can override the default image tag mutability setting.

" + } } }, "traits": { @@ -7073,6 +7158,12 @@ "traits": { "smithy.api#documentation": "

The image tag mutability setting for the repository.

" } + }, + "imageTagMutabilityExclusionFilters": { + "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilters", + "traits": { + "smithy.api#documentation": "

Returns a list of filters that were defined for a repository. These filters determine which image tags can override the default image tag mutability setting of the repository.

" + } } }, "traits": { @@ -7660,6 +7751,12 @@ "smithy.api#documentation": "

The tag mutability setting for the repository.

" } }, + "imageTagMutabilityExclusionFilters": { + "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilters", + "traits": { + "smithy.api#documentation": "

The image tag mutability exclusion filters associated with the repository. These filters specify which image tags can override the repository's default image tag mutability setting.

" + } + }, "imageScanningConfiguration": { "target": "com.amazonaws.ecr#ImageScanningConfiguration" }, @@ -7722,6 +7819,12 @@ "smithy.api#documentation": "

The tag mutability setting for the repository. If this parameter is omitted, the\n default setting of MUTABLE will be used which will allow image tags to be overwritten.\n If IMMUTABLE is specified, all image tags within the repository will be immutable which\n will prevent them from being overwritten.

" } }, + "imageTagMutabilityExclusionFilters": { + "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilters", + "traits": { + "smithy.api#documentation": "

Defines the image tag mutability exclusion filters to apply when creating repositories from this template. These filters specify which image tags can override the repository's default image tag mutability setting.

" + } + }, "repositoryPolicy": { "target": "com.amazonaws.ecr#RepositoryPolicyText", "traits": { @@ -9058,6 +9161,12 @@ "smithy.api#documentation": "

Updates the tag mutability setting for the repository. If this parameter is omitted,\n the default setting of MUTABLE will be used which will allow image tags to\n be overwritten. If IMMUTABLE is specified, all image tags within the\n repository will be immutable which will prevent them from being overwritten.

" } }, + "imageTagMutabilityExclusionFilters": { + "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilters", + "traits": { + "smithy.api#documentation": "

Updates a repository with filters that define which image tags can override the default image tag mutability setting.

" + } + }, "repositoryPolicy": { "target": "com.amazonaws.ecr#RepositoryPolicyText", "traits": { diff --git a/codegen/sdk/aws-models/eks.json b/codegen/sdk/aws-models/eks.json index 4ff2bfff37e..590f2e90497 100644 --- a/codegen/sdk/aws-models/eks.json +++ b/codegen/sdk/aws-models/eks.json @@ -2674,6 +2674,12 @@ "traits": { "smithy.api#documentation": "

Indicates the current configuration of the block storage capability on your EKS Auto\n Mode cluster. For example, if the capability is enabled or disabled. If the block\n storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your\n Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the\n Amazon EKS User Guide.

" } + }, + "deletionProtection": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

The current deletion protection setting for the cluster. When true, \n deletion protection is enabled and the cluster cannot be deleted until protection is \n disabled. When false, the cluster can be deleted normally. This setting \n only applies to clusters in an active state.

" + } } }, "traits": { @@ -3632,6 +3638,12 @@ "traits": { "smithy.api#documentation": "

Enable or disable the block storage capability of EKS Auto Mode when creating your EKS\n Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create\n and delete EBS volumes in your Amazon Web Services account.

" } + }, + "deletionProtection": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to enable deletion protection for the cluster. When enabled, the cluster \n cannot be deleted unless deletion protection is first disabled. This helps prevent \n accidental cluster deletion. Default value is false.

" + } } }, "traits": { @@ -4304,6 +4316,9 @@ { "target": "com.amazonaws.eks#ClientException" }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, { "target": "com.amazonaws.eks#ResourceInUseException" }, @@ -10789,6 +10804,12 @@ }, "remoteNetworkConfig": { "target": "com.amazonaws.eks#RemoteNetworkConfigRequest" + }, + "deletionProtection": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable or disable deletion protection for the cluster. When \n enabled (true), the cluster cannot be deleted until deletion protection is \n explicitly disabled. When disabled (false), the cluster can be deleted \n normally.

" + } } }, "traits": { @@ -11450,6 +11471,12 @@ "traits": { "smithy.api#enumValue": "RemoteNetworkConfig" } + }, + "DELETION_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeletionProtection" + } } } }, @@ -11688,6 +11715,12 @@ "traits": { "smithy.api#enumValue": "RemoteNetworkConfigUpdate" } + }, + "DELETION_PROTECTION_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeletionProtectionUpdate" + } } } }, diff --git a/codegen/sdk/aws-models/elastic-load-balancing-v2.json b/codegen/sdk/aws-models/elastic-load-balancing-v2.json index 8a13f816b17..0f590ee0bb3 100644 --- a/codegen/sdk/aws-models/elastic-load-balancing-v2.json +++ b/codegen/sdk/aws-models/elastic-load-balancing-v2.json @@ -6209,7 +6209,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 can't 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

    \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
\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 can't 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

    \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
\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 secondary_ips.auto_assigned.per_subnet - The number of secondary\n IP addresses to configure for your load balancer nodes. Use to address port \n allocation errors if you can't add targets. The valid range is 0 to 7. The \n default is 0. After you set this value, you can't decrease it.

    \n
    • \n
" } }, "Value": { diff --git a/codegen/sdk/aws-models/emr.json b/codegen/sdk/aws-models/emr.json index d4b2555d2a8..afb6b9ff04b 100644 --- a/codegen/sdk/aws-models/emr.json +++ b/codegen/sdk/aws-models/emr.json @@ -1079,6 +1079,12 @@ "traits": { "smithy.api#documentation": "

The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is\n used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and\n later.

" } + }, + "ExtendedSupport": { + "target": "com.amazonaws.emr#BooleanObject", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } } }, "traits": { @@ -1534,7 +1540,7 @@ "ProfilerType": { "target": "com.amazonaws.emr#ProfilerType", "traits": { - "smithy.api#documentation": "

The profiler type for the persistent application user interface. Valid values are SHS, TEZUI, or YTS.

" + "smithy.api#documentation": "

The profiler type for the persistent application user interface.

" } } }, @@ -7724,6 +7730,12 @@ "traits": { "smithy.api#documentation": "

The number of steps that can be executed concurrently. You can specify a minimum of 1\n step and a maximum of 256 steps. We recommend that you do not change this parameter while\n steps are running or the ActionOnFailure setting may not behave as expected.\n For more information see Step$ActionOnFailure.

" } + }, + "ExtendedSupport": { + "target": "com.amazonaws.emr#BooleanObject", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } } }, "traits": { @@ -7738,6 +7750,12 @@ "traits": { "smithy.api#documentation": "

The number of steps that can be executed concurrently.

" } + }, + "ExtendedSupport": { + "target": "com.amazonaws.emr#BooleanObject", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } } }, "traits": { @@ -9208,6 +9226,12 @@ "traits": { "smithy.api#documentation": "

The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is\n used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and\n later.

" } + }, + "ExtendedSupport": { + "target": "com.amazonaws.emr#BooleanObject", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/entityresolution.json b/codegen/sdk/aws-models/entityresolution.json index ed6d9119a5c..b5756dcf645 100644 --- a/codegen/sdk/aws-models/entityresolution.json +++ b/codegen/sdk/aws-models/entityresolution.json @@ -1120,7 +1120,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.

", + "smithy.api#documentation": "

Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1154,7 +1154,7 @@ "outputSourceConfig": { "target": "com.amazonaws.entityresolution#IdMappingWorkflowOutputSourceConfig", "traits": { - "smithy.api#documentation": "

A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output.

" + "smithy.api#documentation": "

A list of IdMappingWorkflowOutputSource objects, each of which contains fields outputS3Path and KMSArn.

" } }, "idMappingTechniques": { @@ -1216,7 +1216,7 @@ "outputSourceConfig": { "target": "com.amazonaws.entityresolution#IdMappingWorkflowOutputSourceConfig", "traits": { - "smithy.api#documentation": "

A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output.

" + "smithy.api#documentation": "

A list of IdMappingWorkflowOutputSource objects, each of which contains fields outputS3Path and KMSArn.

" } }, "idMappingTechniques": { @@ -1268,7 +1268,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it. Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace API.

", + "smithy.api#documentation": "

Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it. Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace API.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1430,7 +1430,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run. It is important to note that there should not be a pre-existing MatchingWorkflow with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.

", + "smithy.api#documentation": "

Creates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow.

For workflows where resolutionType is ML_MATCHING, incremental processing is not supported.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1464,7 +1464,7 @@ "outputSourceConfig": { "target": "com.amazonaws.entityresolution#OutputSourceConfig", "traits": { - "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

", + "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields outputS3Path, applyNormalization, KMSArn, and output.

", "smithy.api#required": {} } }, @@ -1478,7 +1478,7 @@ "incrementalRunConfig": { "target": "com.amazonaws.entityresolution#IncrementalRunConfig", "traits": { - "smithy.api#documentation": "

An object which defines an incremental run type and has only incrementalRunType as a field.

" + "smithy.api#documentation": "

Optional. An object that defines the incremental run type. This object contains only the incrementalRunType field, which appears as \"Automatic\" in the console.

For workflows where resolutionType is ML_MATCHING, incremental processing is not supported.

" } }, "roleArn": { @@ -1532,7 +1532,7 @@ "outputSourceConfig": { "target": "com.amazonaws.entityresolution#OutputSourceConfig", "traits": { - "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

", + "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields outputS3Path, applyNormalization, KMSArn, and output.

", "smithy.api#required": {} } }, @@ -2504,7 +2504,7 @@ "outputSourceConfig": { "target": "com.amazonaws.entityresolution#IdMappingWorkflowOutputSourceConfig", "traits": { - "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.

" + "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields outputS3Path and KMSArn.

" } }, "idMappingTechniques": { @@ -2952,7 +2952,7 @@ "outputSourceConfig": { "target": "com.amazonaws.entityresolution#OutputSourceConfig", "traits": { - "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

", + "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields outputS3Path, applyNormalization, KMSArn, and output.

", "smithy.api#required": {} } }, @@ -3431,7 +3431,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object containing KMSArn, OutputS3Path, and RoleARN.

" + "smithy.api#documentation": "

An object containing KMSArn, outputS3Path, and roleARN.

" } }, "com.amazonaws.entityresolution#IdMappingJobOutputSourceConfig": { @@ -3479,7 +3479,7 @@ "attributeMatchingModel": { "target": "com.amazonaws.entityresolution#AttributeMatchingModel", "traits": { - "smithy.api#documentation": "

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

", + "smithy.api#documentation": "

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

", "smithy.api#required": {} } }, @@ -3570,7 +3570,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object containing InputSourceARN, SchemaName, and Type.

" + "smithy.api#documentation": "

An object containing inputSourceARN, schemaName, and type.

" } }, "com.amazonaws.entityresolution#IdMappingWorkflowInputSourceConfig": { @@ -3740,7 +3740,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object containing IdMappingType, ProviderProperties, and RuleBasedProperties.

" + "smithy.api#documentation": "

An object containing idMappingType, providerProperties, and ruleBasedProperties.

" } }, "com.amazonaws.entityresolution#IdNamespaceIdMappingWorkflowPropertiesList": { @@ -3774,7 +3774,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object containing InputSourceARN and SchemaName.

" + "smithy.api#documentation": "

An object containing inputSourceARN and schemaName.

" } }, "com.amazonaws.entityresolution#IdNamespaceInputSourceConfig": { @@ -3873,12 +3873,12 @@ "incrementalRunType": { "target": "com.amazonaws.entityresolution#IncrementalRunType", "traits": { - "smithy.api#documentation": "

The type of incremental run. It takes only one value: IMMEDIATE.

" + "smithy.api#documentation": "

The type of incremental run. The only valid value is IMMEDIATE. This appears as \"Automatic\" in the console.

For workflows where resolutionType is ML_MATCHING, incremental processing is not supported.

" } } }, "traits": { - "smithy.api#documentation": "

An object which defines an incremental run type and has only incrementalRunType as a field.

" + "smithy.api#documentation": "

Optional. An object that defines the incremental run type. This object contains only the incrementalRunType field, which appears as \"Automatic\" in the console.

For workflows where resolutionType is ML_MATCHING, incremental processing is not supported.

" } }, "com.amazonaws.entityresolution#IncrementalRunType": { @@ -3918,7 +3918,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object containing InputSourceARN, SchemaName, and ApplyNormalization.

" + "smithy.api#documentation": "

An object containing inputSourceARN, schemaName, and applyNormalization.

" } }, "com.amazonaws.entityresolution#InputSourceConfig": { @@ -4003,7 +4003,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object containing InputRecords, TotalRecordsProcessed, MatchIDs, and RecordsNotProcessed.

" + "smithy.api#documentation": "

An object containing inputRecords, totalRecordsProcessed, matchIDs, and recordsNotProcessed.

" } }, "com.amazonaws.entityresolution#JobOutputSource": { @@ -4031,7 +4031,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object containing KMSArn, OutputS3Path, and RoleArn.

" + "smithy.api#documentation": "

An object containing KMSArn, outputS3Path, and roleArn.

" } }, "com.amazonaws.entityresolution#JobOutputSourceConfig": { @@ -4107,7 +4107,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object containing the JobId, Status, StartTime, and EndTime of a job.

" + "smithy.api#documentation": "

An object containing the jobId, status, startTime, and endTime of a job.

" } }, "com.amazonaws.entityresolution#KMSArn": { @@ -4541,7 +4541,7 @@ "workflowSummaries": { "target": "com.amazonaws.entityresolution#MatchingWorkflowList", "traits": { - "smithy.api#documentation": "

A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.

" + "smithy.api#documentation": "

A list of MatchingWorkflowSummary objects, each of which contain the fields workflowName, workflowArn, resolutionType, createdAt, and updatedAt.

" } }, "nextToken": { @@ -4927,7 +4927,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, UpdatedAt.

" + "smithy.api#documentation": "

A list of MatchingWorkflowSummary objects, each of which contain the fields workflowName, workflowArn, resolutionType, createdAt, updatedAt.

" } }, "com.amazonaws.entityresolution#NamespaceProviderProperties": { @@ -4948,7 +4948,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object containing ProviderConfiguration and ProviderServiceArn.

" + "smithy.api#documentation": "

An object containing providerConfiguration and providerServiceArn.

" } }, "com.amazonaws.entityresolution#NamespaceRuleBasedProperties": { @@ -4973,7 +4973,7 @@ "attributeMatchingModel": { "target": "com.amazonaws.entityresolution#AttributeMatchingModel", "traits": { - "smithy.api#documentation": "

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

" + "smithy.api#documentation": "

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

" } }, "recordMatchingModels": { @@ -5584,7 +5584,13 @@ "ruleBasedProperties": { "target": "com.amazonaws.entityresolution#RuleBasedProperties", "traits": { - "smithy.api#documentation": "

An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.

" + "smithy.api#documentation": "

An object which defines the list of matching rules to run and has a field rules, which is a list of rule objects.

" + } + }, + "ruleConditionProperties": { + "target": "com.amazonaws.entityresolution#RuleConditionProperties", + "traits": { + "smithy.api#documentation": "

An object containing the rules for a matching workflow.

" } }, "providerProperties": { @@ -5670,7 +5676,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object containing RuleName, and MatchingKeys.

" + "smithy.api#documentation": "

An object containing the ruleName and matchingKeys.

" } }, "com.amazonaws.entityresolution#RuleBasedProperties": { @@ -5690,7 +5696,7 @@ "attributeMatchingModel": { "target": "com.amazonaws.entityresolution#AttributeMatchingModel", "traits": { - "smithy.api#documentation": "

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email attribute type.

If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

", + "smithy.api#documentation": "

The comparison type. You can choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email attribute type.

", "smithy.api#required": {} } }, @@ -5702,7 +5708,61 @@ } }, "traits": { - "smithy.api#documentation": "

An object which defines the list of matching rules to run in a matching workflow. RuleBasedProperties contain a Rules field, which is a list of rule objects.

" + "smithy.api#documentation": "

An object which defines the list of matching rules to run in a matching workflow.

" + } + }, + "com.amazonaws.entityresolution#RuleCondition": { + "type": "structure", + "members": { + "ruleName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A name for the matching rule.

For example: Rule1

", + "smithy.api#length": { + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9- ]*$", + "smithy.api#required": {} + } + }, + "condition": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A statement that specifies the conditions for a matching rule.

If your data is accurate, use an Exact matching function: Exact or ExactManyToMany.

If your data has variations in spelling or pronunciation, use a Fuzzy matching function: Cosine, Levenshtein, or Soundex.

Use operators if you want to combine (AND), separate (OR), or group matching functions (...).

For example: (Cosine(a, 10) AND Exact(b, true)) OR ExactManyToMany(c, d)

", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that defines the ruleCondition and the ruleName to use in a matching workflow.

" + } + }, + "com.amazonaws.entityresolution#RuleConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#RuleCondition" + } + }, + "com.amazonaws.entityresolution#RuleConditionProperties": { + "type": "structure", + "members": { + "rules": { + "target": "com.amazonaws.entityresolution#RuleConditionList", + "traits": { + "smithy.api#documentation": "

A list of rule objects, each of which have fields ruleName and condition.

", + "smithy.api#length": { + "min": 1, + "max": 25 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The properties of a rule condition that provides the ability to use more complex syntax.

" } }, "com.amazonaws.entityresolution#RuleList": { @@ -5980,7 +6040,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object containing SchemaName, SchemaArn, CreatedAt, andUpdatedAt.

" + "smithy.api#documentation": "

An object containing schemaName, schemaArn, createdAt, updatedAt, and hasWorkflows.

" } }, "com.amazonaws.entityresolution#Schemas": { @@ -6454,7 +6514,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing IdMappingWorkflow. This method is identical to CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow must already exist for the method to succeed.

", + "smithy.api#documentation": "

Updates an existing IdMappingWorkflow. This method is identical to CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow must already exist for the method to succeed.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -6490,7 +6550,7 @@ "outputSourceConfig": { "target": "com.amazonaws.entityresolution#IdMappingWorkflowOutputSourceConfig", "traits": { - "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.

" + "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields outputS3Path and KMSArn.

" } }, "idMappingTechniques": { @@ -6546,7 +6606,7 @@ "outputSourceConfig": { "target": "com.amazonaws.entityresolution#IdMappingWorkflowOutputSourceConfig", "traits": { - "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.

" + "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields outputS3Path and KMSArn.

" } }, "idMappingTechniques": { @@ -6737,7 +6797,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing MatchingWorkflow. This method is identical to CreateMatchingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the MatchingWorkflow must already exist for the method to succeed.

", + "smithy.api#documentation": "

Updates an existing matching workflow. The workflow must already exist for this operation to succeed.

For workflows where resolutionType is ML_MATCHING, incremental processing is not supported.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -6773,7 +6833,7 @@ "outputSourceConfig": { "target": "com.amazonaws.entityresolution#OutputSourceConfig", "traits": { - "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

", + "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields outputS3Path, applyNormalization, KMSArn, and output.

", "smithy.api#required": {} } }, @@ -6787,7 +6847,7 @@ "incrementalRunConfig": { "target": "com.amazonaws.entityresolution#IncrementalRunConfig", "traits": { - "smithy.api#documentation": "

An object which defines an incremental run type and has only incrementalRunType as a field.

" + "smithy.api#documentation": "

Optional. An object that defines the incremental run type. This object contains only the incrementalRunType field, which appears as \"Automatic\" in the console.

For workflows where resolutionType is ML_MATCHING, incremental processing is not supported.

" } }, "roleArn": { @@ -6828,7 +6888,7 @@ "outputSourceConfig": { "target": "com.amazonaws.entityresolution#OutputSourceConfig", "traits": { - "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

", + "smithy.api#documentation": "

A list of OutputSource objects, each of which contains fields outputS3Path, applyNormalization, KMSArn, and output.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/evs.json b/codegen/sdk/aws-models/evs.json index 8966792b865..3c8b2df5174 100644 --- a/codegen/sdk/aws-models/evs.json +++ b/codegen/sdk/aws-models/evs.json @@ -51,7 +51,7 @@ "*,authorization,date,x-amz-date,x-amz-security-token,x-amz-target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id,amz-sdk-invocation-id,amz-sdk-request" ] }, - "smithy.api#documentation": "

Amazon Elastic VMware Service (Amazon EVS) is a service that you can use to deploy a VMware Cloud Foundation (VCF) software environment directly on EC2 bare metal instances within an Amazon Virtual Private Cloud (VPC).

Workloads running on Amazon EVS are fully compatible with workloads running on any standard VMware vSphere environment. This means that you can migrate any VMware-based workload to Amazon EVS without workload modification.

", + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

Amazon Elastic VMware Service (Amazon EVS) is a service that you can use to deploy a VMware Cloud Foundation (VCF) software environment directly on EC2 bare metal instances within an Amazon Virtual Private Cloud (VPC).

Workloads running on Amazon EVS are fully compatible with workloads running on any standard VMware vSphere environment. This means that you can migrate any VMware-based workload to Amazon EVS without workload modification.

", "smithy.api#title": "Amazon Elastic VMware Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -752,7 +752,7 @@ } }, "traits": { - "smithy.api#documentation": "

A check on the environment to identify environment health and validate VMware VCF licensing compliance.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

A check on the environment to identify environment health and validate VMware VCF licensing compliance.

" } }, "com.amazonaws.evs#CheckResult": { @@ -841,7 +841,7 @@ } }, "traits": { - "smithy.api#documentation": "

The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.

" } }, "com.amazonaws.evs#CreateEnvironment": { @@ -862,7 +862,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.

During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.

It can take several hours to create an environment. After the deployment completes, you can configure VCF according to your unique requirements.

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironment action. This results in a ValidationException response.

EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

", + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.

During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.

It can take several hours to create an environment. After the deployment completes, you can configure VCF in the vSphere user interface according to your needs.

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironment action. This results in a ValidationException response.

", "smithy.api#idempotent": {} } }, @@ -883,7 +883,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an ESXi host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment.

This action can only be used after the Amazon EVS environment is deployed. All Amazon EVS hosts are created with the latest AMI release version for the respective VCF version of the environment.

You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESXi host creation.

You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into.

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironmentHost action. This results in a ValidationException response.

EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

", + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

Creates an ESXi host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment.

This action can only be used after the Amazon EVS environment is deployed. All Amazon EVS hosts are created with the latest AMI release version for the respective VCF version of the environment. Amazon EVS hosts are commissioned in the SDDC Manager inventory as unassigned hosts.

You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESXi host creation.

You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into.

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironmentHost action. This results in a ValidationException response.

", "smithy.api#idempotent": {} } }, @@ -973,7 +973,7 @@ "vpcId": { "target": "com.amazonaws.evs#VpcId", "traits": { - "smithy.api#documentation": "

A unique ID for the VPC that connects to the environment control plane for service access.

Amazon EVS requires that all VPC subnets exist in a single Availability Zone in a Region where the service is available.

The VPC that you select must have a valid DHCP option set with domain name, at least two DNS servers, and an NTP server. These settings are used to configure your VCF appliances and hosts.

If you plan to use HCX over the internet, choose a VPC that has a primary CIDR block and a /28 secondary CIDR block from an IPAM pool. Make sure that your VPC also has an attached internet gateway.

Amazon EVS does not support the following Amazon Web Services networking options for NSX overlay connectivity: cross-Region VPC peering, Amazon S3 gateway endpoints, or Amazon Web Services Direct Connect virtual private gateway associations.

", + "smithy.api#documentation": "

A unique ID for the VPC that the environment is deployed inside.

Amazon EVS requires that all VPC subnets exist in a single Availability Zone in a Region where the service is available.

The VPC that you specify must have a valid DHCP option set with domain name, at least two DNS servers, and an NTP server. These settings are used to configure your VCF appliances and hosts. The VPC cannot be used with any other deployed Amazon EVS environment. Amazon EVS does not provide multi-VPC support for environments at this time.

Amazon EVS does not support the following Amazon Web Services networking options for NSX overlay connectivity: cross-Region VPC peering, Amazon S3 gateway endpoints, or Amazon Web Services Direct Connect virtual private gateway associations.

Ensure that you specify a VPC that is adequately sized to accommodate the {evws} subnets.

", "smithy.api#required": {} } }, @@ -994,35 +994,35 @@ "termsAccepted": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Customer confirmation that the customer has purchased and maintains sufficient VCF software licenses to cover all physical processor cores in the environment, in compliance with VMware's licensing requirements and terms of use.

", + "smithy.api#documentation": "

Customer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment. Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal.

", "smithy.api#required": {} } }, "licenseInfo": { "target": "com.amazonaws.evs#LicenseInfoList", "traits": { - "smithy.api#documentation": "

The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. VCF licenses must have sufficient core entitlements to cover vCPU core and vSAN storage capacity needs.

VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.

VCF license information can be retrieved from the Broadcom portal.

", + "smithy.api#documentation": "

The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. The VCF solution key must cover a minimum of 256 cores. The vSAN license key must provide at least 110 TiB of vSAN capacity.

VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.

VCF license information can be retrieved from the Broadcom portal.

", "smithy.api#required": {} } }, "initialVlans": { "target": "com.amazonaws.evs#InitialVlans", "traits": { - "smithy.api#documentation": "

The initial VLAN subnets for the environment. You must specify a non-overlapping CIDR block for each VLAN subnet.

", + "smithy.api#documentation": "

The initial VLAN subnets for the Amazon EVS environment.

For each Amazon EVS VLAN subnet, you must specify a non-overlapping CIDR block. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.

", "smithy.api#required": {} } }, "hosts": { "target": "com.amazonaws.evs#HostInfoForCreateList", "traits": { - "smithy.api#documentation": "

The ESXi hosts to add to the environment. Amazon EVS requires that you provide details for a minimum of 4 hosts during environment creation.

For each host, you must provide the desired hostname, EC2 SSH key, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts.

", + "smithy.api#documentation": "

The ESXi hosts to add to the environment. Amazon EVS requires that you provide details for a minimum of 4 hosts during environment creation.

For each host, you must provide the desired hostname, EC2 SSH keypair name, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts.

", "smithy.api#required": {} } }, "connectivityInfo": { "target": "com.amazonaws.evs#ConnectivityInfo", "traits": { - "smithy.api#documentation": "

The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX edges over the NSX, providing BGP dynamic routing for overlay networks.

", + "smithy.api#documentation": "

The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX edges over the NSX uplink subnet, providing BGP-based dynamic routing for overlay networks.

", "smithy.api#required": {} } }, @@ -1086,7 +1086,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon EVS environment.

Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the DeleteEnvironmentHost action.

Environment deletion also deletes the associated Amazon EVS VLAN subnets. Other associated Amazon Web Services resources are not deleted. These resources may continue to incur costs.

", + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

Deletes an Amazon EVS environment.

Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the DeleteEnvironmentHost action.

Environment deletion also deletes the associated Amazon EVS VLAN subnets. Other associated Amazon Web Services resources are not deleted. These resources may continue to incur costs.

", "smithy.api#idempotent": {} } }, @@ -1107,7 +1107,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a host from an Amazon EVS environment.

Before deleting a host, you must unassign and decommission the host from within the SDDC Manager user interface. Not doing so could impact the availability of your virtual machines or result in data loss.

", + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

Deletes a host from an Amazon EVS environment.

Before deleting a host, you must unassign and decommission the host from within the SDDC Manager user interface. Not doing so could impact the availability of your virtual machines or result in data loss.

", "smithy.api#idempotent": {} } }, @@ -1263,13 +1263,13 @@ "termsAccepted": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Customer confirmation that the customer has purchased and maintains sufficient VCF software licenses to cover all physical processor cores in the environment, in compliance with VMware's licensing requirements and terms of use.

" + "smithy.api#documentation": "

Customer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment. Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal.

" } }, "licenseInfo": { "target": "com.amazonaws.evs#LicenseInfoList", "traits": { - "smithy.api#documentation": "

The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.

" + "smithy.api#documentation": "

The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. The VCF solution key must cover a minimum of 256 cores. The vSAN license key must provide at least 110 TiB of vSAN capacity.

" } }, "siteId": { @@ -1322,7 +1322,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that represents an Amazon EVS environment.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

An object that represents an Amazon EVS environment.

" } }, "com.amazonaws.evs#EnvironmentId": { @@ -1480,7 +1480,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of environments with summarized environment details.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

A list of environments with summarized environment details.

" } }, "com.amazonaws.evs#EnvironmentSummaryList": { @@ -1506,7 +1506,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a description of the specified environment.

", + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

Returns a description of the specified environment.

", "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { @@ -1634,7 +1634,7 @@ } }, "traits": { - "smithy.api#documentation": "

An ESXi host that runs on an Amazon EC2 bare metal instance. Four hosts are created in an Amazon EVS environment during environment creation. You can add hosts to an environment using the CreateEnvironmentHost operation. Amazon EVS supports 4-16 hosts per environment.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

An ESXi host that runs on an Amazon EC2 bare metal instance. Four hosts are created in an Amazon EVS environment during environment creation. You can add hosts to an environment using the CreateEnvironmentHost operation. Amazon EVS supports 4-16 hosts per environment.

" } }, "com.amazonaws.evs#HostInfoForCreate": { @@ -1675,7 +1675,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that represents a host.

You cannot use dedicatedHostId and placementGroupId together in the same HostInfoForCreateobject. This results in a ValidationException response.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

An object that represents a host.

You cannot use dedicatedHostId and placementGroupId together in the same HostInfoForCreateobject. This results in a ValidationException response.

" } }, "com.amazonaws.evs#HostInfoForCreateList": { @@ -1755,13 +1755,13 @@ "cidr": { "target": "com.amazonaws.evs#Cidr", "traits": { - "smithy.api#documentation": "

The CIDR block that you provide to create a VLAN subnet. VLAN CIDR blocks must not overlap with other subnets in the VPC.

", + "smithy.api#documentation": "

The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

An object that represents an initial VLAN subnet for the environment. Amazon EVS creates initial VLAN subnets when you first create the environment. You must specify a non-overlapping CIDR block for each VLAN subnet. Amazon EVS creates the following 10 VLAN subnets: host management VLAN, vMotion VLAN, vSAN VLAN, VTEP VLAN, Edge VTEP VLAN, Management VM VLAN, HCX uplink VLAN, NSX uplink VLAN, expansion VLAN 1, expansion VLAN 2.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

An object that represents an initial VLAN subnet for the Amazon EVS environment. Amazon EVS creates initial VLAN subnets when you first create the environment. Amazon EVS creates the following 10 VLAN subnets: host management VLAN, vMotion VLAN, vSAN VLAN, VTEP VLAN, Edge VTEP VLAN, Management VM VLAN, HCX uplink VLAN, NSX uplink VLAN, expansion VLAN 1, expansion VLAN 2.

For each Amazon EVS VLAN subnet, you must specify a non-overlapping CIDR block. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.

" } }, "com.amazonaws.evs#InitialVlans": { @@ -1770,7 +1770,7 @@ "vmkManagement": { "target": "com.amazonaws.evs#InitialVlanInfo", "traits": { - "smithy.api#documentation": "

The VMkernel management VLAN subnet. This VLAN subnet carries traffic for managing ESXi hosts and communicating with VMware vCenter Server.

", + "smithy.api#documentation": "

The host VMkernel management VLAN subnet. This VLAN subnet carries traffic for managing ESXi hosts and communicating with VMware vCenter Server.

", "smithy.api#required": {} } }, @@ -1839,7 +1839,7 @@ } }, "traits": { - "smithy.api#documentation": "

The initial VLAN subnets for the environment. You must specify a non-overlapping CIDR block for each VLAN subnet.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

The initial VLAN subnets for the environment. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.

" } }, "com.amazonaws.evs#InstanceType": { @@ -1875,20 +1875,20 @@ "solutionKey": { "target": "com.amazonaws.evs#SolutionKey", "traits": { - "smithy.api#documentation": "

The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server.

", + "smithy.api#documentation": "

The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server. The VCF solution key must cover a minimum of 256 cores.

", "smithy.api#required": {} } }, "vsanKey": { "target": "com.amazonaws.evs#VSanLicenseKey", "traits": { - "smithy.api#documentation": "

The VSAN license key. This license unlocks vSAN features.

", + "smithy.api#documentation": "

The VSAN license key. This license unlocks vSAN features. The vSAN license key must provide at least 110 TiB of vSAN capacity.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.

" } }, "com.amazonaws.evs#LicenseInfoList": { @@ -1920,7 +1920,7 @@ } ], "traits": { - "smithy.api#documentation": "

List the hosts within an environment.

", + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

List the hosts within an environment.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2014,7 +2014,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists environment VLANs that are associated with the specified environment.

", + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

Lists environment VLANs that are associated with the specified environment.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2105,7 +2105,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.

", + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2178,7 +2178,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags for an Amazon EVS resource.

", + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

Lists the tags for an Amazon EVS resource.

", "smithy.api#readonly": {} } }, @@ -2239,7 +2239,7 @@ } }, "traits": { - "smithy.api#documentation": "

An elastic network interface (ENI) that connects hosts to the VLAN subnets. Amazon EVS provisions two identically configured ENIs in the VMkernel management subnet during host creation. One ENI is active, and the other is in standby mode for automatic switchover during a failure scenario.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

An elastic network interface (ENI) that connects hosts to the VLAN subnets. Amazon EVS provisions two identically configured ENIs in the VMkernel management subnet during host creation. One ENI is active, and the other is in standby mode for automatic switchover during a failure scenario.

" } }, "com.amazonaws.evs#NetworkInterfaceId": { @@ -2362,7 +2362,7 @@ } }, "traits": { - "smithy.api#documentation": "

A managed secret that contains the credentials for installing vCenter Server, NSX, and SDDC Manager. During environment creation, the Amazon EVS control plane uses Amazon Web Services Secrets Manager to create, encrypt, validate, and store secrets. If you choose to delete your environment, Amazon EVS also deletes the secrets that are associated with your environment. Amazon EVS does not provide managed rotation of secrets. We recommend that you rotate secrets regularly to ensure that secrets are not long-lived.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

A managed secret that contains the credentials for installing vCenter Server, NSX, and SDDC Manager. During environment creation, the Amazon EVS control plane uses Amazon Web Services Secrets Manager to create, encrypt, validate, and store secrets. If you choose to delete your environment, Amazon EVS also deletes the secrets that are associated with your environment. Amazon EVS does not provide managed rotation of secrets. We recommend that you rotate secrets regularly to ensure that secrets are not long-lived.

" } }, "com.amazonaws.evs#SecretList": { @@ -2403,7 +2403,24 @@ } }, "traits": { - "smithy.api#documentation": "

The security groups that allow traffic between the Amazon EVS control plane and your VPC for Amazon EVS service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

The security groups that allow traffic between the Amazon EVS control plane and your VPC for Amazon EVS service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.

" + } + }, + "com.amazonaws.evs#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Describes the error encountered.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The number of one or more Amazon EVS resources exceeds the maximum allowed. For a list of Amazon EVS quotas, see Amazon EVS endpoints and quotas in the Amazon EVS User Guide. Delete some resources or request an increase in your service quota. To request an increase, see Amazon Web Services Service Quotas in the Amazon Web Services General Reference Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 } }, "com.amazonaws.evs#SolutionKey": { @@ -2459,7 +2476,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request doesn't comply with IAM tag policy. Correct your request and then retry it.

", + "smithy.api#documentation": "

TagPolicyException is deprecated. See ValidationException instead.

The request doesn't comply with IAM tag policy. Correct your request and then retry it.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2476,6 +2493,9 @@ { "target": "com.amazonaws.evs#ResourceNotFoundException" }, + { + "target": "com.amazonaws.evs#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.evs#TagPolicyException" }, @@ -2489,7 +2509,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Associates the specified tags to an Amazon EVS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EVS resources don't propagate to any other resources associated with the environment. For example, if you tag an environment with this operation, that tag doesn't automatically propagate to the VLAN subnets and hosts associated with the environment.

", + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

Associates the specified tags to an Amazon EVS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EVS resources don't propagate to any other resources associated with the environment. For example, if you tag an environment with this operation, that tag doesn't automatically propagate to the VLAN subnets and hosts associated with the environment.

", "smithy.api#idempotent": {} } }, @@ -2577,7 +2597,7 @@ } }, "traits": { - "smithy.api#documentation": "

A service resource associated with the request has more than 200 tags.

", + "smithy.api#documentation": "

TooManyTagsException is deprecated. See ServiceQuotaExceededException instead.

A service resource associated with the request has more than 200 tags.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2603,7 +2623,7 @@ "aws:ResourceTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Deletes specified tags from an Amazon EVS resource.

", + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

Deletes specified tags from an Amazon EVS resource.

", "smithy.api#idempotent": {} } }, @@ -2700,7 +2720,7 @@ } }, "traits": { - "smithy.api#documentation": "

Stores information about a field passed inside a request that resulted in an exception.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

Stores information about a field passed inside a request that resulted in an exception.

" } }, "com.amazonaws.evs#ValidationExceptionFieldList": { @@ -2806,7 +2826,7 @@ } }, "traits": { - "smithy.api#documentation": "

The DNS hostnames that Amazon EVS uses to install VMware vCenter Server, NSX, SDDC Manager, and Cloud Builder. Each hostname must be unique, and resolve to a domain name that you've registered in your DNS service of choice. Hostnames cannot be changed.

VMware VCF requires the deployment of two NSX Edge nodes, and three NSX Manager virtual machines.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

The DNS hostnames that Amazon EVS uses to install VMware vCenter Server, NSX, SDDC Manager, and Cloud Builder. Each hostname must be unique, and resolve to a domain name that you've registered in your DNS service of choice. Hostnames cannot be changed.

VMware VCF requires the deployment of two NSX Edge nodes, and three NSX Manager virtual machines.

" } }, "com.amazonaws.evs#VcfVersion": { @@ -2832,7 +2852,7 @@ "cidr": { "target": "com.amazonaws.evs#Cidr", "traits": { - "smithy.api#documentation": "

The CIDR block of the VLAN.

" + "smithy.api#documentation": "

The CIDR block of the VLAN. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.

" } }, "availabilityZone": { @@ -2879,7 +2899,7 @@ } }, "traits": { - "smithy.api#documentation": "

The VLANs that Amazon EVS creates during environment creation.

" + "smithy.api#documentation": "

Amazon EVS is in public preview release and is subject to change.

The VLANs that Amazon EVS creates during environment creation.

" } }, "com.amazonaws.evs#VlanId": { diff --git a/codegen/sdk/aws-models/glue.json b/codegen/sdk/aws-models/glue.json index 39be1d19b1b..98bad362167 100644 --- a/codegen/sdk/aws-models/glue.json +++ b/codegen/sdk/aws-models/glue.json @@ -1893,6 +1893,12 @@ "traits": { "smithy.api#enumValue": "observations.scope" } + }, + "CompositeOption": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "compositeRuleEvaluation.method" + } } } }, @@ -2772,6 +2778,27 @@ "smithy.api#documentation": "

The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type workflow.

" } }, + "com.amazonaws.glue#AutoDataQuality": { + "type": "structure", + "members": { + "IsEnabled": { + "target": "com.amazonaws.glue#BooleanValue", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether automatic data quality evaluation is enabled. When set to true, data quality checks are performed automatically.

" + } + }, + "EvaluationContext": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The evaluation context for the automatic data quality checks. This defines the scope and parameters for the data quality evaluation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies configuration options for automatic data quality evaluation in Glue jobs. This structure enables automated data quality \n checks and monitoring during ETL operations, helping to ensure data integrity and reliability without manual intervention.

" + } + }, "com.amazonaws.glue#BackfillError": { "type": "structure", "members": { @@ -5330,6 +5357,47 @@ "smithy.api#documentation": "

Specifies a Hudi data source that is registered in the Glue Data Catalog.

" } }, + "com.amazonaws.glue#CatalogIcebergSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the Iceberg data source.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The name of the database to read from.

", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The name of the table in the database to read from.

", + "smithy.api#required": {} + } + }, + "AdditionalIcebergOptions": { + "target": "com.amazonaws.glue#AdditionalOptions", + "traits": { + "smithy.api#documentation": "

Specifies additional connection options for the Iceberg data source.

" + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "

Specifies the data schema for the Iceberg source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an Apache Iceberg data source that is registered in the Glue Data Catalog.

" + } + }, "com.amazonaws.glue#CatalogIdString": { "type": "string", "traits": { @@ -5628,6 +5696,18 @@ "smithy.api#documentation": "

The name of the table in the database to read from.

", "smithy.api#required": {} } + }, + "PartitionPredicate": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

\n Partitions satisfying this predicate are deleted. Files within the retention period in these partitions are not deleted. \n

" + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "

Specifies the data schema for the catalog source.

" + } } }, "traits": { @@ -5895,12 +5975,6 @@ "smithy.api#documentation": "

Specifies a command-separated value (CSV) data store stored in Amazon S3.

" } }, - "S3ExcelSource": { - "target": "com.amazonaws.glue#S3ExcelSource", - "traits": { - "smithy.api#documentation": "

Defines configuration parameters for reading Excel files from Amazon S3.

" - } - }, "S3JsonSource": { "target": "com.amazonaws.glue#S3JsonSource", "traits": { @@ -5961,24 +6035,12 @@ "smithy.api#documentation": "

Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.

" } }, - "S3HyperDirectTarget": { - "target": "com.amazonaws.glue#S3HyperDirectTarget", - "traits": { - "smithy.api#documentation": "

Defines configuration parameters for writing data to Amazon S3 using HyperDirect optimization.

" - } - }, "S3DirectTarget": { "target": "com.amazonaws.glue#S3DirectTarget", "traits": { "smithy.api#documentation": "

Specifies a data target that writes to Amazon S3.

" } }, - "S3IcebergDirectTarget": { - "target": "com.amazonaws.glue#S3IcebergDirectTarget", - "traits": { - "smithy.api#documentation": "

Defines configuration parameters for writing data to Amazon S3 as an Apache Iceberg table.

" - } - }, "ApplyMapping": { "target": "com.amazonaws.glue#ApplyMapping", "traits": { @@ -6171,6 +6233,12 @@ "smithy.api#documentation": "

Specifies a target that uses Postgres SQL.

" } }, + "Route": { + "target": "com.amazonaws.glue#Route", + "traits": { + "smithy.api#documentation": "

Specifies a route node that directs data to different output paths based on defined filtering conditions.

" + } + }, "DynamicTransform": { "target": "com.amazonaws.glue#DynamicTransform", "traits": { @@ -6293,6 +6361,48 @@ "traits": { "smithy.api#documentation": "

Specifies a target generated with standard connection options.

" } + }, + "S3CatalogIcebergSource": { + "target": "com.amazonaws.glue#S3CatalogIcebergSource", + "traits": { + "smithy.api#documentation": "

Specifies an Apache Iceberg data source that is registered in the Glue Data Catalog. The Iceberg data source must be stored in Amazon S3.

" + } + }, + "CatalogIcebergSource": { + "target": "com.amazonaws.glue#CatalogIcebergSource", + "traits": { + "smithy.api#documentation": "

Specifies an Apache Iceberg data source that is registered in the Glue Data Catalog.

" + } + }, + "S3IcebergCatalogTarget": { + "target": "com.amazonaws.glue#S3IcebergCatalogTarget", + "traits": { + "smithy.api#documentation": "

Specifies an Apache Iceberg catalog target that writes data to Amazon S3 and registers the table in the Glue Data Catalog.

" + } + }, + "S3IcebergDirectTarget": { + "target": "com.amazonaws.glue#S3IcebergDirectTarget", + "traits": { + "smithy.api#documentation": "

Defines configuration parameters for writing data to Amazon S3 as an Apache Iceberg table.

" + } + }, + "S3ExcelSource": { + "target": "com.amazonaws.glue#S3ExcelSource", + "traits": { + "smithy.api#documentation": "

Defines configuration parameters for reading Excel files from Amazon S3.

" + } + }, + "S3HyperDirectTarget": { + "target": "com.amazonaws.glue#S3HyperDirectTarget", + "traits": { + "smithy.api#documentation": "

Defines configuration parameters for writing data to Amazon S3 using HyperDirect optimization.

" + } + }, + "DynamoDBELTConnectorSource": { + "target": "com.amazonaws.glue#DynamoDBELTConnectorSource", + "traits": { + "smithy.api#documentation": "

Specifies a DynamoDB ELT connector source for extracting data from DynamoDB tables.

" + } } }, "traits": { @@ -10981,7 +11091,7 @@ "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.

\n
    \n
  • \n

    For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.

    \n
    • \n
  • \n

    For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.

    \n
    • \n
  • \n

    For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).

    \n
    • \n
  • \n

    For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.

    \n
    • \n
  • \n

    For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.

    \n
    • \n
  • \n

    For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.

    \n
    • \n
" + "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.

\n
    \n
  • \n

    For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.

    \n
    • \n
  • \n

    For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.

    \n
    • \n
  • \n

    For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (N. California), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Spain), Europe (Stockholm), and South America (São Paulo).

    \n
    • \n
  • \n

    For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.

    \n
    • \n
  • \n

    For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.

    \n
    • \n
  • \n

    For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.

    \n
    • \n
" } }, "CodeGenConfigurationNodes": { @@ -12792,6 +12902,79 @@ "target": "smithy.api#String" } }, + "com.amazonaws.glue#DDBELTCatalogAdditionalOptions": { + "type": "structure", + "members": { + "DynamodbExport": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

Specifies the DynamoDB export configuration for the ELT operation.

" + } + }, + "DynamodbUnnestDDBJson": { + "target": "com.amazonaws.glue#BooleanValue", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to unnest DynamoDB JSON format. When set to true, nested JSON structures in DynamoDB items are flattened.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies additional options for DynamoDB ELT catalog operations.

" + } + }, + "com.amazonaws.glue#DDBELTConnectionOptions": { + "type": "structure", + "members": { + "DynamodbExport": { + "target": "com.amazonaws.glue#DdbExportType", + "traits": { + "smithy.api#documentation": "

Specifies the export type for DynamoDB data extraction. This parameter determines how data is exported from the DynamoDB table during the ELT process.

" + } + }, + "DynamodbUnnestDDBJson": { + "target": "com.amazonaws.glue#BooleanValue", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean value that specifies whether to unnest DynamoDB JSON format during data extraction. When set to true, the connector will \n flatten nested JSON structures from DynamoDB items. When set to false, the original DynamoDB JSON structure is preserved.

" + } + }, + "DynamodbTableArn": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the DynamoDB table to extract data from. This parameter specifies the source table for the ELT operation. \n

", + "smithy.api#required": {} + } + }, + "DynamodbS3Bucket": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket used for intermediate storage during the DynamoDB ELT process. This bucket is used to temporarily store exported \n DynamoDB data before it is processed by the ELT job.

" + } + }, + "DynamodbS3Prefix": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The S3 object key prefix for files stored in the intermediate S3 bucket during the DynamoDB ELT process. This prefix helps organize and identify the \n temporary files created during data extraction.

" + } + }, + "DynamodbS3BucketOwner": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the S3 bucket specified in DynamodbS3Bucket. This parameter is required when the S3 bucket is owned by \n a different Amazon Web Services account than the one running the ELT job, enabling cross-account access to the intermediate storage bucket.

" + } + }, + "DynamodbStsRoleArn": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Security Token Service (STS) role to assume for accessing DynamoDB and S3 resources during \n the ELT operation. \n This role must have the necessary permissions to read from the DynamoDB table and write to the intermediate S3 bucket.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies connection options for DynamoDB ELT (Extract, Load, Transform) operations. This structure contains configuration parameters for connecting \n to and extracting data from DynamoDB tables using the ELT connector.

" + } + }, "com.amazonaws.glue#DQAdditionalOptions": { "type": "map", "key": { @@ -14229,6 +14412,23 @@ "smithy.api#documentation": "

Defines column statistics supported for timestamp data columns.

" } }, + "com.amazonaws.glue#DdbExportType": { + "type": "enum", + "members": { + "ddb": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ddb" + } + }, + "s3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "s3" + } + } + } + }, "com.amazonaws.glue#DecimalColumnStatisticsData": { "type": "structure", "members": { @@ -16983,6 +17183,12 @@ "traits": { "smithy.api#documentation": "

The temp directory of the JDBC Redshift source.

" } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "

Specifies the data schema for the direct JDBC source.

" + } } }, "traits": { @@ -17333,12 +17539,51 @@ "smithy.api#documentation": "

The name of the table in the database to read from.

", "smithy.api#required": {} } + }, + "PitrEnabled": { + "target": "com.amazonaws.glue#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether Point-in-Time Recovery (PITR) is enabled for the DynamoDB table. When set to true, \n allows reading from a specific point in time. The default value is false.

" + } + }, + "AdditionalOptions": { + "target": "com.amazonaws.glue#DDBELTCatalogAdditionalOptions", + "traits": { + "smithy.api#documentation": "

Specifies additional connection options for the DynamoDB data source.

" + } } }, "traits": { "smithy.api#documentation": "

Specifies a DynamoDB data source in the Glue Data Catalog.

" } }, + "com.amazonaws.glue#DynamoDBELTConnectorSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the DynamoDB ELT connector source.

", + "smithy.api#required": {} + } + }, + "ConnectionOptions": { + "target": "com.amazonaws.glue#DDBELTConnectionOptions", + "traits": { + "smithy.api#documentation": "

The connection options for the DynamoDB ELT connector source.

" + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "

Specifies the data schema for the DynamoDB ELT connector source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a DynamoDB ELT connector source for extracting data from DynamoDB tables.

" + } + }, "com.amazonaws.glue#DynamoDBTarget": { "type": "structure", "members": { @@ -25597,6 +25842,12 @@ "traits": { "smithy.api#documentation": "

The hive type for this column in the Glue Studio schema.

" } + }, + "GlueStudioType": { + "target": "com.amazonaws.glue#ColumnTypeString", + "traits": { + "smithy.api#documentation": "

The data type of the column as defined in Glue Studio.

" + } } }, "traits": { @@ -25839,6 +26090,41 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\t]*$" } }, + "com.amazonaws.glue#GroupFilters": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.glue#GenericLimitedString", + "traits": { + "smithy.api#documentation": "

The name of the filter group.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.glue#FilterExpressions", + "traits": { + "smithy.api#documentation": "

A list of filter expressions that define the conditions for this group.

", + "smithy.api#required": {} + } + }, + "LogicalOperator": { + "target": "com.amazonaws.glue#FilterLogicalOperator", + "traits": { + "smithy.api#documentation": "

The logical operator used to combine the filters in this group. Determines whether all filters must match (AND) or any filter can match (OR).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a group of filters with a logical operator that determines how the filters are combined to evaluate routing conditions.

" + } + }, + "com.amazonaws.glue#GroupFiltersList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#GroupFilters" + } + }, "com.amazonaws.glue#HashString": { "type": "string", "traits": { @@ -27851,7 +28137,7 @@ "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.

\n
    \n
  • \n

    For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.

    \n
    • \n
  • \n

    For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.

    \n
    • \n
  • \n

    For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).

    \n
    • \n
  • \n

    For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.

    \n
    • \n
  • \n

    For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.

    \n
    • \n
  • \n

    For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.

    \n
    • \n
" + "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs.

\n

Glue provides multiple worker types to accommodate different workload requirements:

\n

G Worker Types (General-purpose compute workers):

\n
    \n
  • \n

    G.1X: 1 DPU (4 vCPUs, 16 GB memory, 94GB disk)

    \n
    • \n
  • \n

    G.2X: 2 DPU (8 vCPUs, 32 GB memory, 138GB disk)

    \n
    • \n
  • \n

    G.4X: 4 DPU (16 vCPUs, 64 GB memory, 256GB disk)

    \n
    • \n
  • \n

    G.8X: 8 DPU (32 vCPUs, 128 GB memory, 512GB disk)

    \n
    • \n
  • \n

    G.12X: 12 DPU (48 vCPUs, 192 GB memory, 768GB disk)

    \n
    • \n
  • \n

    G.16X: 16 DPU (64 vCPUs, 256 GB memory, 1024GB disk)

    \n
    • \n
\n

R Worker Types (Memory-optimized workers):

\n
    \n
  • \n

    R.1X: 1 M-DPU (4 vCPUs, 32 GB memory)

    \n
    • \n
  • \n

    R.2X: 2 M-DPU (8 vCPUs, 64 GB memory)

    \n
    • \n
  • \n

    R.4X: 4 M-DPU (16 vCPUs, 128 GB memory)

    \n
    • \n
  • \n

    R.8X: 8 M-DPU (32 vCPUs, 256 GB memory)

    \n
    • \n
" } }, "NumberOfWorkers": { @@ -28269,6 +28555,12 @@ "traits": { "smithy.api#documentation": "

This field holds details that pertain to the state of a job run. The field is nullable.

\n

For example, when a job run is in a WAITING state as a result of job run queuing, the field has the reason why the job run is in that state.

" } + }, + "ExecutionRoleSessionPolicy": { + "target": "com.amazonaws.glue#OrchestrationPolicyJsonString", + "traits": { + "smithy.api#documentation": "

This inline session policy to the StartJobRun API allows you to dynamically restrict the permissions of the specified \n execution role for the scope of the job, without requiring the creation of additional IAM roles.

" + } } }, "traits": { @@ -28441,7 +28733,7 @@ "WorkerType": { "target": "com.amazonaws.glue#WorkerType", "traits": { - "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.

\n
    \n
  • \n

    For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.

    \n
    • \n
  • \n

    For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.

    \n
    • \n
  • \n

    For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).

    \n
    • \n
  • \n

    For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the G.4X worker type.

    \n
    • \n
  • \n

    For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs.

    \n
    • \n
  • \n

    For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.

    \n
    • \n
" + "smithy.api#documentation": "

The type of predefined worker that is allocated when a job runs. Accepts a value of\n G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs. For more information, see \n Defining job properties for Spark jobs \n \n

" } }, "NumberOfWorkers": { @@ -28986,6 +29278,12 @@ "traits": { "smithy.api#documentation": "

The timestamp of the record in the Kinesis data stream to start reading data from. The possible values are a timestamp string in UTC format of the pattern yyyy-mm-ddTHH:MM:SSZ (where Z represents a UTC timezone offset with a +/-. For example: \"2023-04-04T08:00:00+08:00\").

" } + }, + "FanoutConsumerARN": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis Data Streams enhanced fan-out consumer. When specified, enables enhanced fan-out for \n dedicated throughput and lower latency data consumption.

" + } } }, "traits": { @@ -32891,6 +33189,15 @@ } } }, + "com.amazonaws.glue#OrchestrationPolicyJsonString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2048 + } + } + }, "com.amazonaws.glue#OrchestrationRoleArn": { "type": "string", "traits": { @@ -33072,6 +33379,48 @@ "traits": { "smithy.api#documentation": "

Indicates the value that will replace the detected entity.

" } + }, + "RedactText": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

Specifies whether to redact the detected PII text. When set to true, PII content is replaced with redaction characters.

" + } + }, + "RedactChar": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The character used to replace detected PII content when redaction is enabled. The default redaction character is *.

" + } + }, + "MatchPattern": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

A regular expression pattern used to identify additional PII content beyond the standard detection algorithms.

" + } + }, + "NumLeftCharsToExclude": { + "target": "com.amazonaws.glue#BoxedPositiveInt", + "traits": { + "smithy.api#documentation": "

The number of characters to exclude from redaction on the left side of detected PII content. This allows preserving context around the sensitive data.

" + } + }, + "NumRightCharsToExclude": { + "target": "com.amazonaws.glue#BoxedPositiveInt", + "traits": { + "smithy.api#documentation": "

The number of characters to exclude from redaction on the right side of detected PII content. This allows preserving context around the sensitive data.

" + } + }, + "DetectionParameters": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

Additional parameters for configuring PII detection behavior and sensitivity settings.

" + } + }, + "DetectionSensitivity": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The sensitivity level for PII detection. Higher sensitivity levels detect more potential PII but may result in more false positives.

" + } } }, "traits": { @@ -33669,18 +34018,36 @@ "smithy.api#enumValue": "RowAudit" } }, + "RowHashing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RowHashing" + } + }, "RowMasking": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RowMasking" } }, + "RowPartialMasking": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RowPartialMasking" + } + }, "ColumnAudit": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ColumnAudit" } }, + "ColumnHashing": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ColumnHashing" + } + }, "ColumnMasking": { "target": "smithy.api#Unit", "traits": { @@ -35680,6 +36047,35 @@ "com.amazonaws.glue#RoleString": { "type": "string" }, + "com.amazonaws.glue#Route": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the route node.

", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "

The input connection for the route node.

", + "smithy.api#required": {} + } + }, + "GroupFiltersList": { + "target": "com.amazonaws.glue#GroupFiltersList", + "traits": { + "smithy.api#documentation": "

A list of group filters that define the routing conditions and criteria for directing data to different output paths.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a route node that directs data to different output paths based on defined filtering conditions.

" + } + }, "com.amazonaws.glue#RowTag": { "type": "string" }, @@ -35935,6 +36331,47 @@ "smithy.api#documentation": "

Specifies a Hudi data source that is registered in the Glue Data Catalog. The Hudi data source must be stored in Amazon S3.

" } }, + "com.amazonaws.glue#S3CatalogIcebergSource": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the Iceberg data source.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The name of the database to read from.

", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The name of the table in the database to read from.

", + "smithy.api#required": {} + } + }, + "AdditionalIcebergOptions": { + "target": "com.amazonaws.glue#AdditionalOptions", + "traits": { + "smithy.api#documentation": "

Specifies additional connection options for the Iceberg data source.

" + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "

Specifies the data schema for the Iceberg source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an Apache Iceberg data source that is registered in the Glue Data Catalog. The Iceberg data source must be stored in Amazon S3.

" + } + }, "com.amazonaws.glue#S3CatalogSource": { "type": "structure", "members": { @@ -36018,6 +36455,12 @@ "traits": { "smithy.api#documentation": "

A policy that specifies update behavior for the crawler.

" } + }, + "AutoDataQuality": { + "target": "com.amazonaws.glue#AutoDataQuality", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically enable data quality evaluation for the S3 catalog target. \n When set to true, data quality checks are performed automatically during the write operation.

" + } } }, "traits": { @@ -36199,6 +36642,18 @@ "traits": { "smithy.api#documentation": "

A policy that specifies update behavior for the crawler.

" } + }, + "AutoDataQuality": { + "target": "com.amazonaws.glue#AutoDataQuality", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically enable data quality evaluation for the S3 Delta catalog target. When set to true, \n data quality checks are performed automatically during the write operation.

" + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "

Specifies the data schema for the S3 Delta catalog target.

" + } } }, "traits": { @@ -36266,6 +36721,12 @@ "traits": { "smithy.api#documentation": "

A policy that specifies update behavior for the crawler.

" } + }, + "AutoDataQuality": { + "target": "com.amazonaws.glue#AutoDataQuality", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically enable data quality evaluation for the S3 Delta direct target. When set to true, \n data quality checks are performed automatically during the write operation.

" + } } }, "traits": { @@ -36398,6 +36859,18 @@ "traits": { "smithy.api#documentation": "

A policy that specifies update behavior for the crawler.

" } + }, + "AutoDataQuality": { + "target": "com.amazonaws.glue#AutoDataQuality", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically enable data quality evaluation for the S3 direct target. When set to true, \n data quality checks are performed automatically during the write operation.

" + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "

Specifies the data schema for the S3 direct target.

" + } } }, "traits": { @@ -36533,7 +37006,7 @@ "OutputSchemas": { "target": "com.amazonaws.glue#GlueSchemas", "traits": { - "smithy.api#documentation": "

The AWS Glue schemas to apply to the processed data.

" + "smithy.api#documentation": "

The Glue schemas to apply to the processed data.

" } } }, @@ -36580,7 +37053,7 @@ "NumberTargetPartitions": { "target": "com.amazonaws.glue#NumberTargetPartitionsString", "traits": { - "smithy.api#documentation": "

Specifies the number of target partitions for Parquet files when writing to Amazon S3 using AWS Glue.

" + "smithy.api#documentation": "

Specifies the number of target partitions for Parquet files when writing to Amazon S3 using Glue.

" } }, "SchemaChangePolicy": { @@ -36588,6 +37061,12 @@ "traits": { "smithy.api#documentation": "

A policy that specifies update behavior for the crawler.

" } + }, + "AutoDataQuality": { + "target": "com.amazonaws.glue#AutoDataQuality", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically enable data quality evaluation for the S3 Glue Parquet target. When set to true, \n data quality checks are performed automatically during the write operation.

" + } } }, "traits": { @@ -36643,6 +37122,18 @@ "traits": { "smithy.api#documentation": "

A policy that specifies update behavior for the crawler.

" } + }, + "AutoDataQuality": { + "target": "com.amazonaws.glue#AutoDataQuality", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically enable data quality evaluation for the S3 Hudi catalog target. When set to true, \n data quality checks are performed automatically during the write operation.

" + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "

Specifies the data schema for the S3 Hudi catalog target.

" + } } }, "traits": { @@ -36711,6 +37202,12 @@ "traits": { "smithy.api#documentation": "

A policy that specifies update behavior for the crawler.

" } + }, + "AutoDataQuality": { + "target": "com.amazonaws.glue#AutoDataQuality", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically enable data quality evaluation for the S3 Hudi direct target. When set to true, \n data quality checks are performed automatically during the write operation.

" + } } }, "traits": { @@ -36774,6 +37271,12 @@ "smithy.api#required": {} } }, + "Format": { + "target": "com.amazonaws.glue#TargetFormat", + "traits": { + "smithy.api#documentation": "

Specifies the data output format for the HyperDirect target.

" + } + }, "PartitionKeys": { "target": "com.amazonaws.glue#GlueStudioPathList", "traits": { @@ -36798,12 +37301,84 @@ "traits": { "smithy.api#documentation": "

Defines how schema changes are handled during write operations.

" } + }, + "AutoDataQuality": { + "target": "com.amazonaws.glue#AutoDataQuality", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically enable data quality evaluation for the S3 Hyper direct target. When set to true, data quality checks are performed automatically during the write operation.

" + } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "

Specifies the data schema for the S3 Hyper direct target.

" + } } }, "traits": { "smithy.api#documentation": "

Specifies a HyperDirect data target that writes to Amazon S3.

" } }, + "com.amazonaws.glue#S3IcebergCatalogTarget": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the Iceberg catalog target.

", + "smithy.api#required": {} + } + }, + "Inputs": { + "target": "com.amazonaws.glue#OneInput", + "traits": { + "smithy.api#documentation": "

The input connection for the Iceberg catalog target.

", + "smithy.api#required": {} + } + }, + "PartitionKeys": { + "target": "com.amazonaws.glue#GlueStudioPathList", + "traits": { + "smithy.api#documentation": "

A list of partition keys for the Iceberg table.

" + } + }, + "Table": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The name of the table to write to in the catalog.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.glue#EnclosedInStringProperty", + "traits": { + "smithy.api#documentation": "

The name of the database to write to.

", + "smithy.api#required": {} + } + }, + "AdditionalOptions": { + "target": "com.amazonaws.glue#AdditionalOptions", + "traits": { + "smithy.api#documentation": "

Specifies additional connection options for the Iceberg catalog target.

" + } + }, + "SchemaChangePolicy": { + "target": "com.amazonaws.glue#CatalogSchemaChangePolicy", + "traits": { + "smithy.api#documentation": "

The policy for handling schema changes in the catalog target.

" + } + }, + "AutoDataQuality": { + "target": "com.amazonaws.glue#AutoDataQuality", + "traits": { + "smithy.api#documentation": "

Specifies whether to automatically enable data quality evaluation for the S3 Iceberg catalog target. When set to true, data quality checks are performed automatically during the write operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an Apache Iceberg catalog target that writes data to Amazon S3 and registers the table in the Glue Data Catalog.

" + } + }, "com.amazonaws.glue#S3IcebergDirectTarget": { "type": "structure", "members": { @@ -36853,6 +37428,9 @@ "smithy.api#documentation": "

Defines how schema changes are handled when writing data to the Iceberg table.

" } }, + "AutoDataQuality": { + "target": "com.amazonaws.glue#AutoDataQuality" + }, "Compression": { "target": "com.amazonaws.glue#IcebergTargetCompressionType", "traits": { @@ -36865,6 +37443,12 @@ "traits": { "smithy.api#documentation": "

Sets the number of target partitions for distributing Iceberg table files across S3.

" } + }, + "OutputSchemas": { + "target": "com.amazonaws.glue#GlueSchemas", + "traits": { + "smithy.api#documentation": "

Specifies the data schema for the S3 Iceberg direct target.

" + } } }, "traits": { @@ -39586,6 +40170,12 @@ "traits": { "smithy.api#documentation": "

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

\n

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

\n

Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

" } + }, + "ExecutionRoleSessionPolicy": { + "target": "com.amazonaws.glue#OrchestrationPolicyJsonString", + "traits": { + "smithy.api#documentation": "

This inline session policy to the StartJobRun API allows you to dynamically restrict the permissions of the specified\n execution role for the scope of the job, without requiring the creation of additional IAM roles.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/inspector2.json b/codegen/sdk/aws-models/inspector2.json index 9b7eeaee478..bfd6f7803d0 100644 --- a/codegen/sdk/aws-models/inspector2.json +++ b/codegen/sdk/aws-models/inspector2.json @@ -331,6 +331,10 @@ { "value": "AWS_LAMBDA_FUNCTION", "name": "AWS_LAMBDA_FUNCTION" + }, + { + "value": "CODE_REPOSITORY", + "name": "CODE_REPOSITORY" } ] } @@ -18199,6 +18203,10 @@ { "name": "CODE_REPOSITORY_SCA", "value": "CODE_REPOSITORY_SCA" + }, + { + "name": "EC2_AGENTLESS_INSTANCE_HOURS", + "value": "EC2_AGENTLESS_INSTANCE_HOURS" } ] } diff --git a/codegen/sdk/aws-models/iot-wireless.json b/codegen/sdk/aws-models/iot-wireless.json index cf6f35bc775..dc96d88e5f8 100644 --- a/codegen/sdk/aws-models/iot-wireless.json +++ b/codegen/sdk/aws-models/iot-wireless.json @@ -9599,6 +9599,30 @@ "traits": { "smithy.api#documentation": "

The MinGwDiversity value.

" } + }, + "TxPowerIndexMin": { + "target": "com.amazonaws.iotwireless#TxPowerIndexMin", + "traits": { + "smithy.api#documentation": "

The Transmit Power Index minimum value.

\n

Default: 0\n

" + } + }, + "TxPowerIndexMax": { + "target": "com.amazonaws.iotwireless#TxPowerIndexMax", + "traits": { + "smithy.api#documentation": "

The Transmit Power Index maximum value.

\n

Default: 15\n

" + } + }, + "NbTransMin": { + "target": "com.amazonaws.iotwireless#NbTransMin", + "traits": { + "smithy.api#documentation": "

The minimum number of transmissions.

\n

Default: 0\n

" + } + }, + "NbTransMax": { + "target": "com.amazonaws.iotwireless#NbTransMax", + "traits": { + "smithy.api#documentation": "

The maximum number of transmissions.

\n

Default: 3\n

" + } } }, "traits": { @@ -9823,6 +9847,30 @@ "smithy.api#default": false, "smithy.api#documentation": "

The RAAllowed value that describes whether roaming activation is allowed.

" } + }, + "TxPowerIndexMin": { + "target": "com.amazonaws.iotwireless#TxPowerIndexMin", + "traits": { + "smithy.api#documentation": "

The Transmit Power Index minimum.

\n

Default: 0\n

" + } + }, + "TxPowerIndexMax": { + "target": "com.amazonaws.iotwireless#TxPowerIndexMax", + "traits": { + "smithy.api#documentation": "

The Transmit Power Index maximum.

\n

Default: 15\n

" + } + }, + "NbTransMin": { + "target": "com.amazonaws.iotwireless#NbTransMin", + "traits": { + "smithy.api#documentation": "

The minimum number of transmissions.

\n

Default: 0\n

" + } + }, + "NbTransMax": { + "target": "com.amazonaws.iotwireless#NbTransMax", + "traits": { + "smithy.api#documentation": "

The maximum number of transmissions.

\n

Default: 3\n

" + } } }, "traits": { @@ -10754,6 +10802,24 @@ "smithy.api#default": false } }, + "com.amazonaws.iotwireless#NbTransMax": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.iotwireless#NbTransMin": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 15 + } + } + }, "com.amazonaws.iotwireless#NetId": { "type": "string", "traits": { @@ -13845,6 +13911,24 @@ } } }, + "com.amazonaws.iotwireless#TxPowerIndexMax": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.iotwireless#TxPowerIndexMin": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 15 + } + } + }, "com.amazonaws.iotwireless#UARFCN": { "type": "integer", "traits": { diff --git a/codegen/sdk/aws-models/iot.json b/codegen/sdk/aws-models/iot.json index 69d35575f90..dbc3b0c588d 100644 --- a/codegen/sdk/aws-models/iot.json +++ b/codegen/sdk/aws-models/iot.json @@ -336,6 +336,9 @@ { "target": "com.amazonaws.iot#DescribeDomainConfiguration" }, + { + "target": "com.amazonaws.iot#DescribeEncryptionConfiguration" + }, { "target": "com.amazonaws.iot#DescribeEndpoint" }, @@ -786,6 +789,9 @@ { "target": "com.amazonaws.iot#UpdateDynamicThingGroup" }, + { + "target": "com.amazonaws.iot#UpdateEncryptionConfiguration" + }, { "target": "com.amazonaws.iot#UpdateEventConfigurations" }, @@ -6823,6 +6829,49 @@ "smithy.api#documentation": "

Configuration.

" } }, + "com.amazonaws.iot#ConfigurationDetails": { + "type": "structure", + "members": { + "configurationStatus": { + "target": "com.amazonaws.iot#ConfigurationStatus", + "traits": { + "smithy.api#documentation": "

The health status of KMS key and KMS access role. If either KMS key or KMS access role\n is UNHEALTHY, the return value will be UNHEALTHY. To use a\n customer-managed KMS key, the value of configurationStatus must be\n HEALTHY.

" + } + }, + "errorCode": { + "target": "com.amazonaws.iot#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code that indicates either the KMS key or the KMS access role is UNHEALTHY. \n Valid values: KMS_KEY_VALIDATION_ERROR and ROLE_VALIDATION_ERROR.\n

" + } + }, + "errorMessage": { + "target": "com.amazonaws.iot#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The detailed error message that corresponds to the errorCode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The encryption configuration details that include the status information of the Amazon Web Services Key Management Service (KMS) key and the KMS access role.

" + } + }, + "com.amazonaws.iot#ConfigurationStatus": { + "type": "enum", + "members": { + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTHY" + } + }, + "UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNHEALTHY" + } + } + } + }, "com.amazonaws.iot#ConfirmTopicRuleDestination": { "type": "operation", "input": { @@ -10353,6 +10402,9 @@ }, { "target": "com.amazonaws.iot#SqlParseException" + }, + { + "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { @@ -10387,6 +10439,9 @@ }, { "target": "com.amazonaws.iot#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { @@ -14206,6 +14261,85 @@ "smithy.api#output": {} } }, + "com.amazonaws.iot#DescribeEncryptionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#DescribeEncryptionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.iot#DescribeEncryptionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the encryption configuration for resources and data of your Amazon Web Services account in\n Amazon Web Services IoT Core. For more information, see Key management in IoT from\n the Amazon Web Services IoT Core Developer Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/encryption-configuration", + "code": 200 + } + } + }, + "com.amazonaws.iot#DescribeEncryptionConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#DescribeEncryptionConfigurationResponse": { + "type": "structure", + "members": { + "encryptionType": { + "target": "com.amazonaws.iot#EncryptionType", + "traits": { + "smithy.api#documentation": "

The type of the Amazon Web Services Key Management Service (KMS) key.

" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.iot#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role assumed by Amazon Web Services IoT Core to call KMS on\n behalf of the customer.

" + } + }, + "kmsAccessRoleArn": { + "target": "com.amazonaws.iot#KmsAccessRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the customer-managed KMS key.

" + } + }, + "configurationDetails": { + "target": "com.amazonaws.iot#ConfigurationDetails", + "traits": { + "smithy.api#documentation": "

The encryption configuration details that include the status information of the KMS key\n and the KMS access role.

" + } + }, + "lastModifiedDate": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "

The date when encryption configuration is last updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iot#DescribeEndpoint": { "type": "operation", "input": { @@ -17429,6 +17563,23 @@ "com.amazonaws.iot#EnabledBoolean": { "type": "boolean" }, + "com.amazonaws.iot#EncryptionType": { + "type": "enum", + "members": { + "CUSTOMER_MANAGED_KMS_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_MANAGED_KMS_KEY" + } + }, + "AWS_OWNED_KMS_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_OWNED_KMS_KEY" + } + } + } + }, "com.amazonaws.iot#EndpointAddress": { "type": "string" }, @@ -21590,6 +21741,24 @@ "smithy.api#documentation": "

Describes an action to write data to an Amazon Kinesis stream.

" } }, + "com.amazonaws.iot#KmsAccessRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.iot#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, "com.amazonaws.iot#LambdaAction": { "type": "structure", "members": { @@ -27469,6 +27638,9 @@ }, { "target": "com.amazonaws.iot#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { @@ -35519,7 +35691,7 @@ } ], "traits": { - "smithy.api#documentation": "

Transfers the specified certificate to the specified Amazon Web Services account.

\n

Requires permission to access the TransferCertificate action.

\n

You can cancel the transfer until it is acknowledged by the recipient.

\n

No notification is sent to the transfer destination's account. It is up to the caller\n to notify the transfer target.

\n

The certificate being transferred must not be in the ACTIVE state. You can use the\n UpdateCertificate action to deactivate it.

\n

The certificate must not have any policies attached to it. You can use the\n DetachPolicy action to detach them.

", + "smithy.api#documentation": "

Transfers the specified certificate to the specified Amazon Web Services account.

\n

Requires permission to access the TransferCertificate action.

\n

You can cancel the transfer until it is acknowledged by the recipient.

\n

No notification is sent to the transfer destination's account. It's up to the caller\n to notify the transfer target.

\n

The certificate being transferred must not be in the ACTIVE state. You can use the\n UpdateCertificate action to deactivate it.

\n

The certificate must not have any policies attached to it. You can use the\n DetachPolicy action to detach them.

\n

\n Customer managed key behavior: When you use a customer managed key to secure your data and then transfer\n the key to a customer in a different account using the TransferCertificate operation, the certificates will no longer be protected by their \n customer managed key configuration. During the transfer process, certificates are encrypted using IoT owned keys.

\n

While a certificate is in the PENDING_TRANSFER state, it's always protected by IoT owned keys, regardless of the customer managed key configuration of either the source or destination account.

\n

Once the transfer is completed through AcceptCertificateTransfer, RejectCertificateTransfer, or\n CancelCertificateTransfer, the certificate will be protected by the customer managed key configuration of the account that owns\n the certificate after the transfer operation:

\n
    \n
  • \n

    If the transfer is accepted: The certificate is protected by the destination account's customer managed key configuration.

    \n
    • \n
  • \n

    If the transfer is rejected or cancelled: The certificate is protected by the source account's customer managed key configuration.

    \n
    • \n
", "smithy.api#http": { "method": "PATCH", "uri": "/transfer-certificate/{certificateId}", @@ -36838,6 +37010,85 @@ "smithy.api#output": {} } }, + "com.amazonaws.iot#UpdateEncryptionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#UpdateEncryptionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.iot#UpdateEncryptionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the encryption configuration. By default, all Amazon Web Services IoT Core data at rest is\n encrypted using Amazon Web Services owned keys. Amazon Web Services IoT Core also supports symmetric customer managed keys\n from Amazon Web Services Key Management Service (KMS). With customer managed keys, you create, own, and\n manage the KMS keys in your Amazon Web Services account. For more information, see Data\n encryption in the Amazon Web Services IoT Core Developer Guide.

", + "smithy.api#examples": [ + { + "title": "UpdateEncryptionConfiguration example", + "documentation": "This operation updates the encryption configuration. ", + "input": { + "encryptionType": "CUSTOMER_MANAGED_KMS_KEY", + "kmsKeyArn": "arn:aws:iam:us-west-2:111122223333:role/myrole", + "kmsAccessRoleArn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + } + } + ], + "smithy.api#http": { + "method": "PATCH", + "uri": "/encryption-configuration", + "code": 200 + } + } + }, + "com.amazonaws.iot#UpdateEncryptionConfigurationRequest": { + "type": "structure", + "members": { + "encryptionType": { + "target": "com.amazonaws.iot#EncryptionType", + "traits": { + "smithy.api#documentation": "

The type of the Amazon Web Services Key Management Service (KMS) key.

", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.iot#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the customer-managed KMS key.

" + } + }, + "kmsAccessRoleArn": { + "target": "com.amazonaws.iot#KmsAccessRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role assumed by Amazon Web Services IoT Core to call KMS on\n behalf of the customer.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#UpdateEncryptionConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iot#UpdateEventConfigurations": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/iotsitewise.json b/codegen/sdk/aws-models/iotsitewise.json index aa991a91792..db2c6802462 100644 --- a/codegen/sdk/aws-models/iotsitewise.json +++ b/codegen/sdk/aws-models/iotsitewise.json @@ -82,6 +82,9 @@ { "target": "com.amazonaws.iotsitewise#CreateBulkImportJob" }, + { + "target": "com.amazonaws.iotsitewise#CreateComputationModel" + }, { "target": "com.amazonaws.iotsitewise#CreateDashboard" }, @@ -109,6 +112,12 @@ { "target": "com.amazonaws.iotsitewise#DeleteAssetModelCompositeModel" }, + { + "target": "com.amazonaws.iotsitewise#DeleteAssetModelInterfaceRelationship" + }, + { + "target": "com.amazonaws.iotsitewise#DeleteComputationModel" + }, { "target": "com.amazonaws.iotsitewise#DeleteDashboard" }, @@ -145,12 +154,21 @@ { "target": "com.amazonaws.iotsitewise#DescribeAssetModelCompositeModel" }, + { + "target": "com.amazonaws.iotsitewise#DescribeAssetModelInterfaceRelationship" + }, { "target": "com.amazonaws.iotsitewise#DescribeAssetProperty" }, { "target": "com.amazonaws.iotsitewise#DescribeBulkImportJob" }, + { + "target": "com.amazonaws.iotsitewise#DescribeComputationModel" + }, + { + "target": "com.amazonaws.iotsitewise#DescribeComputationModelExecutionSummary" + }, { "target": "com.amazonaws.iotsitewise#DescribeDashboard" }, @@ -160,6 +178,9 @@ { "target": "com.amazonaws.iotsitewise#DescribeDefaultEncryptionConfiguration" }, + { + "target": "com.amazonaws.iotsitewise#DescribeExecution" + }, { "target": "com.amazonaws.iotsitewise#DescribeGateway" }, @@ -241,15 +262,30 @@ { "target": "com.amazonaws.iotsitewise#ListCompositionRelationships" }, + { + "target": "com.amazonaws.iotsitewise#ListComputationModelDataBindingUsages" + }, + { + "target": "com.amazonaws.iotsitewise#ListComputationModelResolveToResources" + }, + { + "target": "com.amazonaws.iotsitewise#ListComputationModels" + }, { "target": "com.amazonaws.iotsitewise#ListDashboards" }, { "target": "com.amazonaws.iotsitewise#ListDatasets" }, + { + "target": "com.amazonaws.iotsitewise#ListExecutions" + }, { "target": "com.amazonaws.iotsitewise#ListGateways" }, + { + "target": "com.amazonaws.iotsitewise#ListInterfaceRelationships" + }, { "target": "com.amazonaws.iotsitewise#ListPortals" }, @@ -265,6 +301,9 @@ { "target": "com.amazonaws.iotsitewise#ListTimeSeries" }, + { + "target": "com.amazonaws.iotsitewise#PutAssetModelInterfaceRelationship" + }, { "target": "com.amazonaws.iotsitewise#PutDefaultEncryptionConfiguration" }, @@ -295,6 +334,9 @@ { "target": "com.amazonaws.iotsitewise#UpdateAssetProperty" }, + { + "target": "com.amazonaws.iotsitewise#UpdateComputationModel" + }, { "target": "com.amazonaws.iotsitewise#UpdateDashboard" }, @@ -1302,10 +1344,16 @@ "traits": { "smithy.api#documentation": "

The resource the action will be taken on.

" } + }, + "resolveTo": { + "target": "com.amazonaws.iotsitewise#ResolveTo", + "traits": { + "smithy.api#documentation": "

The detailed resource this action resolves to.

" + } } }, "traits": { - "smithy.api#documentation": "

Contains the summary of the actions.

" + "smithy.api#documentation": "

Contains the summary of the actions, including information about where the action resolves\n to.

" } }, "com.amazonaws.iotsitewise#AdaptiveIngestion": { @@ -1474,6 +1522,21 @@ } } }, + "com.amazonaws.iotsitewise#AssetBindingValueFilter": { + "type": "structure", + "members": { + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset to filter data bindings by. Only data bindings referencing this\n specific asset are matched.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter used to match data bindings based on a specific asset. This filter identifies all\n computation models referencing a particular asset in their data bindings.

" + } + }, "com.amazonaws.iotsitewise#AssetCompositeModel": { "type": "structure", "members": { @@ -1666,18 +1729,18 @@ "smithy.api#documentation": "

The ID of the hierarchy. This ID is a hierarchyId.

" } }, + "externalId": { + "target": "com.amazonaws.iotsitewise#ExternalId", + "traits": { + "smithy.api#documentation": "

The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you\n may assign an external ID if it doesn't already have one. You can't change the external ID of\n an asset hierarchy that already has one. For more information, see Using external IDs in the IoT SiteWise User Guide.

" + } + }, "name": { "target": "com.amazonaws.iotsitewise#Name", "traits": { "smithy.api#documentation": "

The hierarchy name provided in the CreateAssetModel or UpdateAssetModel\n API operation.

", "smithy.api#required": {} } - }, - "externalId": { - "target": "com.amazonaws.iotsitewise#ExternalId", - "traits": { - "smithy.api#documentation": "

The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you\n may assign an external ID if it doesn't already have one. You can't change the external ID of\n an asset hierarchy that already has one. For more information, see Using external IDs in the IoT SiteWise User Guide.

" - } } }, "traits": { @@ -1710,6 +1773,21 @@ "target": "com.amazonaws.iotsitewise#ID" } }, + "com.amazonaws.iotsitewise#AssetModelBindingValueFilter": { + "type": "structure", + "members": { + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model to filter data bindings by. Only data bindings referemncing this\n specific asset model are matched.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter used to match data bindings based on a specific asset model. This filter\n identifies all computation models referencing a particular asset model in their data\n bindings.

" + } + }, "com.amazonaws.iotsitewise#AssetModelCompositeModel": { "type": "structure", "members": { @@ -2038,6 +2116,50 @@ "smithy.api#documentation": "

Contains information about an asset model property.

" } }, + "com.amazonaws.iotsitewise#AssetModelPropertyBindingValue": { + "type": "structure", + "members": { + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model, in UUID format.

", + "smithy.api#required": {} + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model property used in data binding value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an assetModelProperty binding value.

" + } + }, + "com.amazonaws.iotsitewise#AssetModelPropertyBindingValueFilter": { + "type": "structure", + "members": { + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model containing the filter property. This identifies the specific\n asset model that contains the property of interest.

", + "smithy.api#required": {} + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the property within the asset model to filter by. Only data bindings referencing\n this specific property of the specified asset model are matched.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter used to match data bindings based on a specific asset model property. This filter\n identifies all computation models that reference a particular property of an asset model in\n their data bindings.

" + } + }, "com.amazonaws.iotsitewise#AssetModelPropertyDefinition": { "type": "structure", "members": { @@ -2187,10 +2309,16 @@ "traits": { "smithy.api#documentation": "

The structured path to the property from the root of the asset model.

" } + }, + "interfaceSummaries": { + "target": "com.amazonaws.iotsitewise#InterfaceSummaries", + "traits": { + "smithy.api#documentation": "

A list of interface summaries that describe which interfaces this property belongs to,\n including the interface asset model ID and the corresponding property ID in the\n interface.

" + } } }, "traits": { - "smithy.api#documentation": "

Contains a summary of a property associated with a model.

" + "smithy.api#documentation": "

Contains a summary of a property associated with a model. This includes information about\n which interfaces the property belongs to, if any.

" } }, "com.amazonaws.iotsitewise#AssetModelState": { @@ -2350,6 +2478,12 @@ "traits": { "smithy.api#enumValue": "COMPONENT_MODEL" } + }, + "INTERFACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERFACE" + } } } }, @@ -2392,6 +2526,12 @@ "smithy.api#required": {} } }, + "externalId": { + "target": "com.amazonaws.iotsitewise#ExternalId", + "traits": { + "smithy.api#documentation": "

The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.

" + } + }, "name": { "target": "com.amazonaws.iotsitewise#Name", "traits": { @@ -2435,12 +2575,6 @@ "traits": { "smithy.api#documentation": "

The structured path to the property from the root of the asset.

" } - }, - "externalId": { - "target": "com.amazonaws.iotsitewise#ExternalId", - "traits": { - "smithy.api#documentation": "

The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.

" - } } }, "traits": { @@ -2457,6 +2591,50 @@ "smithy.api#pattern": "^[^\\u0000-\\u001F\\u007F]+$" } }, + "com.amazonaws.iotsitewise#AssetPropertyBindingValue": { + "type": "structure", + "members": { + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset containing the property. This identifies the specific asset instance's\n property value used in the computation model.

", + "smithy.api#required": {} + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the property within the asset. This identifies the specific property's value\n used in the computation model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a data binding value referencing a specific asset property. It's used to bind\n computation model variables to actual asset property values for processing.

" + } + }, + "com.amazonaws.iotsitewise#AssetPropertyBindingValueFilter": { + "type": "structure", + "members": { + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset containing the property to filter by. This identifies the specific\n asset instance containing the property of interest.

", + "smithy.api#required": {} + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the property within the asset to filter by. Only data bindings referencing this\n specific property of the specified asset are matched.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter used to match data bindings based on a specific asset property. This filter helps\n identify all computation models referencing a particular property of an asset in their data\n bindings.

" + } + }, "com.amazonaws.iotsitewise#AssetPropertyPath": { "type": "list", "member": { @@ -2499,6 +2677,12 @@ "smithy.api#required": {} } }, + "externalId": { + "target": "com.amazonaws.iotsitewise#ExternalId", + "traits": { + "smithy.api#documentation": "

The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.

" + } + }, "alias": { "target": "com.amazonaws.iotsitewise#PropertyAlias", "traits": { @@ -2525,12 +2709,6 @@ "traits": { "smithy.api#documentation": "

The structured path to the property from the root of the asset.

" } - }, - "externalId": { - "target": "com.amazonaws.iotsitewise#ExternalId", - "traits": { - "smithy.api#documentation": "

The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.

" - } } }, "traits": { @@ -2687,6 +2865,12 @@ "smithy.api#required": {} } }, + "externalId": { + "target": "com.amazonaws.iotsitewise#ExternalId", + "traits": { + "smithy.api#documentation": "

The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

" + } + }, "arn": { "target": "com.amazonaws.iotsitewise#ARN", "traits": { @@ -2741,12 +2925,6 @@ "traits": { "smithy.api#documentation": "

A description for the asset.

" } - }, - "externalId": { - "target": "com.amazonaws.iotsitewise#ExternalId", - "traits": { - "smithy.api#documentation": "

The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

" - } } }, "traits": { @@ -2925,6 +3103,12 @@ "smithy.api#required": {} } }, + "externalId": { + "target": "com.amazonaws.iotsitewise#ExternalId", + "traits": { + "smithy.api#documentation": "

The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

" + } + }, "arn": { "target": "com.amazonaws.iotsitewise#ARN", "traits": { @@ -2979,12 +3163,6 @@ "traits": { "smithy.api#documentation": "

A description for the asset.

" } - }, - "externalId": { - "target": "com.amazonaws.iotsitewise#ExternalId", - "traits": { - "smithy.api#documentation": "

The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

" - } } }, "traits": { @@ -4296,7 +4474,7 @@ "enablePartialEntryProcessing": { "target": "com.amazonaws.iotsitewise#BooleanValue", "traits": { - "smithy.api#documentation": "

This setting enables partial ingestion at entry-level. If set to true, we ingest all TQVs not resulting in an error. If set to \n false, an invalid TQV fails ingestion of the entire entry that contains it.

" + "smithy.api#documentation": "

This setting enables partial ingestion at entry-level. If set to true, we\n ingest all TQVs not resulting in an error. If set to false, an invalid TQV fails\n ingestion of the entire entry that contains it.

" } }, "entries": { @@ -4326,6 +4504,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.iotsitewise#BindingValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#ComputationModelDataBindingValue" + } + }, "com.amazonaws.iotsitewise#BooleanValue": { "type": "boolean" }, @@ -4636,70 +4820,363 @@ "smithy.api#documentation": "

Contains a summary of the components of the composite model.

" } }, - "com.amazonaws.iotsitewise#ComputeLocation": { - "type": "enum", + "com.amazonaws.iotsitewise#ComputationModelAnomalyDetectionConfiguration": { + "type": "structure", "members": { - "EDGE": { - "target": "smithy.api#Unit", + "inputProperties": { + "target": "com.amazonaws.iotsitewise#InputProperties", "traits": { - "smithy.api#enumValue": "EDGE" + "smithy.api#documentation": "

Define the variable name associated with input properties, with the following format\n ${VariableName}.

", + "smithy.api#required": {} } }, - "CLOUD": { - "target": "smithy.api#Unit", + "resultProperty": { + "target": "com.amazonaws.iotsitewise#ResultProperty", "traits": { - "smithy.api#enumValue": "CLOUD" + "smithy.api#documentation": "

Define the variable name associated with the result property, and the following format\n ${VariableName}.

", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the configuration of the type of anomaly detection computation model.

" } }, - "com.amazonaws.iotsitewise#ConfigurationErrorDetails": { + "com.amazonaws.iotsitewise#ComputationModelConfiguration": { "type": "structure", "members": { - "code": { - "target": "com.amazonaws.iotsitewise#ErrorCode", + "anomalyDetection": { + "target": "com.amazonaws.iotsitewise#ComputationModelAnomalyDetectionConfiguration", "traits": { - "smithy.api#documentation": "

The error code.

", + "smithy.api#documentation": "

The configuration for the anomaly detection type of computation model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for the computation model.

" + } + }, + "com.amazonaws.iotsitewise#ComputationModelDataBinding": { + "type": "map", + "key": { + "target": "com.amazonaws.iotsitewise#ComputationModelDataBindingVariable" + }, + "value": { + "target": "com.amazonaws.iotsitewise#ComputationModelDataBindingValue" + } + }, + "com.amazonaws.iotsitewise#ComputationModelDataBindingUsageSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#ComputationModelDataBindingUsageSummary" + } + }, + "com.amazonaws.iotsitewise#ComputationModelDataBindingUsageSummary": { + "type": "structure", + "members": { + "computationModelIds": { + "target": "com.amazonaws.iotsitewise#ComputationModelIdList", + "traits": { + "smithy.api#documentation": "

The list of computation model IDs that use this data binding. This allows identification\n of all computation models affected by changes to the referenced data source.

", "smithy.api#required": {} } }, - "message": { - "target": "com.amazonaws.iotsitewise#ErrorMessage", + "matchedDataBinding": { + "target": "com.amazonaws.iotsitewise#MatchedDataBinding", "traits": { - "smithy.api#documentation": "

The error message.

", + "smithy.api#documentation": "

The data binding matched by the filter criteria. Contains details about specific data\n binding values used by the computation models.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains the details of an IoT SiteWise configuration error.

" + "smithy.api#documentation": "

A summary of how a specific data binding is used across computation models. This tracks\n dependencies between data sources and computation models, allowing you to understand the\n impact of changes to data sources.

" } }, - "com.amazonaws.iotsitewise#ConfigurationState": { - "type": "enum", + "com.amazonaws.iotsitewise#ComputationModelDataBindingValue": { + "type": "structure", "members": { - "ACTIVE": { - "target": "smithy.api#Unit", + "assetModelProperty": { + "target": "com.amazonaws.iotsitewise#AssetModelPropertyBindingValue", "traits": { - "smithy.api#enumValue": "ACTIVE" + "smithy.api#documentation": "

Specifies an asset model property data binding value.

" } }, - "UPDATE_IN_PROGRESS": { - "target": "smithy.api#Unit", + "assetProperty": { + "target": "com.amazonaws.iotsitewise#AssetPropertyBindingValue", "traits": { - "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + "smithy.api#documentation": "

The asset property value used for computation model data binding.

" } }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", + "list": { + "target": "com.amazonaws.iotsitewise#BindingValueList", "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" + "smithy.api#documentation": "

Specifies a list of data binding value.

" } } + }, + "traits": { + "smithy.api#documentation": "

Contains computation model data binding value information, which can be one of\n assetModelProperty, list.

" } }, - "com.amazonaws.iotsitewise#ConfigurationStatus": { - "type": "structure", + "com.amazonaws.iotsitewise#ComputationModelDataBindingVariable": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-z][a-z0-9_]*$" + } + }, + "com.amazonaws.iotsitewise#ComputationModelExecutionSummary": { + "type": "map", + "key": { + "target": "com.amazonaws.iotsitewise#ComputationModelExecutionSummaryKey" + }, + "value": { + "target": "com.amazonaws.iotsitewise#ComputationModelExecutionSummaryValue" + } + }, + "com.amazonaws.iotsitewise#ComputationModelExecutionSummaryKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9 _\\-#$*!@]+$" + } + }, + "com.amazonaws.iotsitewise#ComputationModelExecutionSummaryValue": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9 _\\-#$*!@]+$" + } + }, + "com.amazonaws.iotsitewise#ComputationModelIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#ID" + } + }, + "com.amazonaws.iotsitewise#ComputationModelResolveToResourceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#ComputationModelResolveToResourceSummary" + } + }, + "com.amazonaws.iotsitewise#ComputationModelResolveToResourceSummary": { + "type": "structure", + "members": { + "resolveTo": { + "target": "com.amazonaws.iotsitewise#ResolveTo" + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the resource that a computation model resolves to.

" + } + }, + "com.amazonaws.iotsitewise#ComputationModelState": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.iotsitewise#ComputationModelStatus": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.iotsitewise#ComputationModelState", + "traits": { + "smithy.api#documentation": "

The current state of the computation model.

", + "smithy.api#required": {} + } + }, + "error": { + "target": "com.amazonaws.iotsitewise#ErrorDetails" + } + }, + "traits": { + "smithy.api#documentation": "

Contains current status information for a computation model.

" + } + }, + "com.amazonaws.iotsitewise#ComputationModelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#ComputationModelSummary" + } + }, + "com.amazonaws.iotsitewise#ComputationModelSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the computation model.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotsitewise#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the computation model, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}\n

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.iotsitewise#RestrictedName", + "traits": { + "smithy.api#documentation": "

The name of the computation model.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iotsitewise#RestrictedDescription", + "traits": { + "smithy.api#documentation": "

The description of the computation model.

" + } + }, + "type": { + "target": "com.amazonaws.iotsitewise#ComputationModelType", + "traits": { + "smithy.api#documentation": "

The type of the computation model.

", + "smithy.api#required": {} + } + }, + "creationDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The model creation date, in Unix epoch time.

", + "smithy.api#required": {} + } + }, + "lastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the model was last updated, in Unix epoch time.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.iotsitewise#ComputationModelStatus", + "traits": { + "smithy.api#documentation": "

The current status of the computation model.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.iotsitewise#Version", + "traits": { + "smithy.api#documentation": "

The version of the computation model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a summary of a computation model.

" + } + }, + "com.amazonaws.iotsitewise#ComputationModelType": { + "type": "enum", + "members": { + "ANOMALY_DETECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANOMALY_DETECTION" + } + } + } + }, + "com.amazonaws.iotsitewise#ComputeLocation": { + "type": "enum", + "members": { + "EDGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EDGE" + } + }, + "CLOUD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUD" + } + } + } + }, + "com.amazonaws.iotsitewise#ConfigurationErrorDetails": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.iotsitewise#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.iotsitewise#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of an IoT SiteWise configuration error.

" + } + }, + "com.amazonaws.iotsitewise#ConfigurationState": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } + } + }, + "com.amazonaws.iotsitewise#ConfigurationStatus": { + "type": "structure", "members": { "state": { "target": "com.amazonaws.iotsitewise#ConfigurationState", @@ -4982,7 +5459,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an asset model from specified property and hierarchy definitions. You create\n assets from asset models. With asset models, you can easily create assets of the same type\n that have standardized definitions. Each asset created from a model inherits the asset model's\n property and hierarchy definitions. For more information, see Defining asset models in the\n IoT SiteWise User Guide.

\n

You can create two types of asset models, ASSET_MODEL or\n COMPONENT_MODEL.

\n
    \n
  • \n

    \n ASSET_MODEL – (default) An asset model that\n you can use to create assets. Can't be included as a component in another asset\n model.

    \n
    • \n
  • \n

    \n COMPONENT_MODEL – A reusable component that\n you can include in the composite models of other asset models. You can't create\n assets directly from this type of asset model.

    \n
    • \n
", + "smithy.api#documentation": "

Creates an asset model from specified property and hierarchy definitions. You create\n assets from asset models. With asset models, you can easily create assets of the same type\n that have standardized definitions. Each asset created from a model inherits the asset model's\n property and hierarchy definitions. For more information, see Defining asset models in the\n IoT SiteWise User Guide.

\n

You can create three types of asset models, ASSET_MODEL,\n COMPONENT_MODEL, or an INTERFACE.

\n
    \n
  • \n

    \n ASSET_MODEL – (default) An asset model that\n you can use to create assets. Can't be included as a component in another asset\n model.

    \n
    • \n
  • \n

    \n COMPONENT_MODEL – A reusable component that\n you can include in the composite models of other asset models. You can't create\n assets directly from this type of asset model.

    \n
    • \n
  • \n

    \n INTERFACE – An interface is a type of model\n that defines a standard structure that can be applied to different asset models.

    \n
    • \n
", "smithy.api#endpoint": { "hostPrefix": "api." }, @@ -5277,6 +5754,18 @@ "smithy.api#required": {} } }, + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID to assign to the asset, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.\n However, if you prefer to supply your own ID instead, you can specify it here in UUID format.\n If you specify your own ID, it must be globally unique.

" + } + }, + "assetExternalId": { + "target": "com.amazonaws.iotsitewise#ExternalId", + "traits": { + "smithy.api#documentation": "

An external ID to assign to the asset. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

" + } + }, "clientToken": { "target": "com.amazonaws.iotsitewise#ClientToken", "traits": { @@ -5295,18 +5784,6 @@ "traits": { "smithy.api#documentation": "

A description for the asset.

" } - }, - "assetId": { - "target": "com.amazonaws.iotsitewise#ID", - "traits": { - "smithy.api#documentation": "

The ID to assign to the asset, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.\n However, if you prefer to supply your own ID instead, you can specify it here in UUID format.\n If you specify your own ID, it must be globally unique.

" - } - }, - "assetExternalId": { - "target": "com.amazonaws.iotsitewise#ExternalId", - "traits": { - "smithy.api#documentation": "

An external ID to assign to the asset. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

" - } } }, "traits": { @@ -5374,7 +5851,7 @@ } ], "traits": { - "smithy.api#documentation": "

Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a\n bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

\n \n

Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier.\n For more information about how to configure storage settings, see PutStorageConfiguration.

\n

Bulk import is designed to store historical data to IoT SiteWise. It does not trigger\n computations or notifications on IoT SiteWise warm or cold tier storage.

\n ", + "smithy.api#documentation": "

Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a\n bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

\n \n

Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier.\n For more information about how to configure storage settings, see PutStorageConfiguration.

\n

Bulk import is designed to store historical data to IoT SiteWise.

\n
    \n
  • \n

    Newly ingested data in the hot tier triggers notifications and computations.

    \n
    • \n
  • \n

    After data moves from the hot tier to the warm or cold tier based on retention\n settings, it does not trigger computations or notifications.

    \n
    • \n
  • \n

    Data older than 7 days does not trigger computations or notifications.

    \n
    • \n
\n ", "smithy.api#endpoint": { "hostPrefix": "data." }, @@ -5469,15 +5946,18 @@ "smithy.api#output": {} } }, - "com.amazonaws.iotsitewise#CreateDashboard": { + "com.amazonaws.iotsitewise#CreateComputationModel": { "type": "operation", "input": { - "target": "com.amazonaws.iotsitewise#CreateDashboardRequest" + "target": "com.amazonaws.iotsitewise#CreateComputationModelRequest" }, "output": { - "target": "com.amazonaws.iotsitewise#CreateDashboardResponse" + "target": "com.amazonaws.iotsitewise#CreateComputationModelResponse" }, "errors": [ + { + "target": "com.amazonaws.iotsitewise#ConflictingOperationException" + }, { "target": "com.amazonaws.iotsitewise#InternalFailureException" }, @@ -5487,6 +5967,9 @@ { "target": "com.amazonaws.iotsitewise#LimitExceededException" }, + { + "target": "com.amazonaws.iotsitewise#ResourceAlreadyExistsException" + }, { "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" }, @@ -5495,7 +5978,121 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a dashboard in an IoT SiteWise Monitor project.

", + "smithy.api#documentation": "

Create a computation model with a configuration and data binding.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/computation-models", + "code": 202 + } + } + }, + "com.amazonaws.iotsitewise#CreateComputationModelRequest": { + "type": "structure", + "members": { + "computationModelName": { + "target": "com.amazonaws.iotsitewise#RestrictedName", + "traits": { + "smithy.api#documentation": "

The name of the computation model.

", + "smithy.api#required": {} + } + }, + "computationModelDescription": { + "target": "com.amazonaws.iotsitewise#RestrictedDescription", + "traits": { + "smithy.api#documentation": "

The description of the computation model.

" + } + }, + "computationModelConfiguration": { + "target": "com.amazonaws.iotsitewise#ComputationModelConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the computation model.

", + "smithy.api#required": {} + } + }, + "computationModelDataBinding": { + "target": "com.amazonaws.iotsitewise#ComputationModelDataBinding", + "traits": { + "smithy.api#documentation": "

The data binding for the computation model. Key is a variable name defined in configuration. \n Value is a ComputationModelDataBindingValue referenced by the variable.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.iotsitewise#TagMap", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs that contain metadata for the asset. For more information, see\n Tagging your IoT SiteWise\n resources in the IoT SiteWise User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#CreateComputationModelResponse": { + "type": "structure", + "members": { + "computationModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the computation model.

", + "smithy.api#required": {} + } + }, + "computationModelArn": { + "target": "com.amazonaws.iotsitewise#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the computation model, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}\n

", + "smithy.api#required": {} + } + }, + "computationModelStatus": { + "target": "com.amazonaws.iotsitewise#ComputationModelStatus", + "traits": { + "smithy.api#documentation": "

The status of the computation model, containing a state (CREATING after successfully\n calling this operation) and any error messages.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iotsitewise#CreateDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#CreateDashboardRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#CreateDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a dashboard in an IoT SiteWise Monitor project.

", "smithy.api#endpoint": { "hostPrefix": "monitor." }, @@ -5752,7 +6349,7 @@ "gatewayVersion": { "target": "com.amazonaws.iotsitewise#GatewayVersion", "traits": { - "smithy.api#documentation": "

The version of the gateway to create. Specify 3 to create an MQTT-enabled, V3\n gateway and 2 To create a Classic streams, V2 gateway. If the version isn't\n specified, a Classic streams, V2 gateway is created by default.

\n

We recommend creating an MQTT-enabled, V3 gateway for self-hosted gateways. SiteWise Edge\n gateways on Siemens Industrial Edge should use gateway version 2. For more information on\n gateway versions, see Self-host a SiteWise Edge\n gateway with IoT Greengrass V2.

" + "smithy.api#documentation": "

The version of the gateway to create. Specify 3 to create an MQTT-enabled, V3\n gateway and 2 to create a Classic streams, V2 gateway. If not specified, the\n default is 2 (Classic streams, V2 gateway).

\n \n

When creating a V3 gateway (gatewayVersion=3) with the\n GreengrassV2 platform, you must also specify the\n coreDeviceOperatingSystem parameter.

\n \n

We recommend creating an MQTT-enabled gateway for self-hosted gateways and Siemens\n Industrial Edge gateways. For more information on gateway versions, see Use Amazon Web Services IoT SiteWise Edge Edge\n gateways.

" } }, "tags": { @@ -5788,6 +6385,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.iotsitewise#CreateMissingProperty": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.iotsitewise#CreatePortal": { "type": "operation", "input": { @@ -6074,7 +6677,7 @@ "min": 13, "max": 139 }, - "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9]+$" + "smithy.api#pattern": "^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\\-0-9.:]*[a-zA-Z0-9_]+$" } }, "com.amazonaws.iotsitewise#CustomerManagedS3Storage": { @@ -6155,6 +6758,55 @@ "smithy.api#documentation": "

Contains a dashboard summary.

" } }, + "com.amazonaws.iotsitewise#DataBindingValue": { + "type": "structure", + "members": { + "assetModelProperty": { + "target": "com.amazonaws.iotsitewise#AssetModelPropertyBindingValue" + }, + "assetProperty": { + "target": "com.amazonaws.iotsitewise#AssetPropertyBindingValue", + "traits": { + "smithy.api#documentation": "

The asset property value used in the data binding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a value used in a data binding. It can be an asset property or an asset model\n property.

" + } + }, + "com.amazonaws.iotsitewise#DataBindingValueFilter": { + "type": "structure", + "members": { + "asset": { + "target": "com.amazonaws.iotsitewise#AssetBindingValueFilter", + "traits": { + "smithy.api#documentation": "

Filter criteria for matching data bindings based on a specific asset. Used to list all\n data bindings referencing a particular asset or its properties.

" + } + }, + "assetModel": { + "target": "com.amazonaws.iotsitewise#AssetModelBindingValueFilter", + "traits": { + "smithy.api#documentation": "

Filter criteria for matching data bindings based on a specific asset model. Used to list\n all data bindings referencing a particular asset model or its properties.

" + } + }, + "assetProperty": { + "target": "com.amazonaws.iotsitewise#AssetPropertyBindingValueFilter", + "traits": { + "smithy.api#documentation": "

Filter criteria for matching data bindings based on a specific asset property. Used to\n list all data bindings referencing a particular property of an asset.

" + } + }, + "assetModelProperty": { + "target": "com.amazonaws.iotsitewise#AssetModelPropertyBindingValueFilter", + "traits": { + "smithy.api#documentation": "

Filter criteria for matching data bindings based on a specific asset model property. Used\n to list all data bindings referencing a particular property of an asset model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter used to match specific data binding values based on criteria. This filter allows\n searching for data bindings by asset, asset model, asset property, or asset model\n property.

" + } + }, "com.amazonaws.iotsitewise#DataSetReference": { "type": "structure", "members": { @@ -6634,6 +7286,110 @@ "smithy.api#output": {} } }, + "com.amazonaws.iotsitewise#DeleteAssetModelInterfaceRelationship": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#DeleteAssetModelInterfaceRelationshipRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#DeleteAssetModelInterfaceRelationshipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#ConflictingOperationException" + }, + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an interface relationship between an asset model and an interface asset\n model.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "DELETE", + "uri": "/asset-models/{assetModelId}/interface/{interfaceAssetModelId}/asset-model-interface-relationship", + "code": 202 + } + } + }, + "com.amazonaws.iotsitewise#DeleteAssetModelInterfaceRelationshipRequest": { + "type": "structure", + "members": { + "assetModelId": { + "target": "com.amazonaws.iotsitewise#CustomID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model. This can be either the actual ID in UUID format, or else\n externalId: followed by the external ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "interfaceAssetModelId": { + "target": "com.amazonaws.iotsitewise#CustomID", + "traits": { + "smithy.api#documentation": "

The ID of the interface asset model. This can be either the actual ID in UUID format, or\n else externalId: followed by the external ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the\n request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#DeleteAssetModelInterfaceRelationshipResponse": { + "type": "structure", + "members": { + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model.

", + "smithy.api#required": {} + } + }, + "interfaceAssetModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the interface asset model.

", + "smithy.api#required": {} + } + }, + "assetModelArn": { + "target": "com.amazonaws.iotsitewise#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the asset model, which has the following format.\n arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}\n

", + "smithy.api#required": {} + } + }, + "assetModelStatus": { + "target": "com.amazonaws.iotsitewise#AssetModelStatus", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iotsitewise#DeleteAssetModelRequest": { "type": "structure", "members": { @@ -6733,15 +7489,18 @@ "smithy.api#output": {} } }, - "com.amazonaws.iotsitewise#DeleteDashboard": { + "com.amazonaws.iotsitewise#DeleteComputationModel": { "type": "operation", "input": { - "target": "com.amazonaws.iotsitewise#DeleteDashboardRequest" + "target": "com.amazonaws.iotsitewise#DeleteComputationModelRequest" }, "output": { - "target": "com.amazonaws.iotsitewise#DeleteDashboardResponse" + "target": "com.amazonaws.iotsitewise#DeleteComputationModelResponse" }, "errors": [ + { + "target": "com.amazonaws.iotsitewise#ConflictingOperationException" + }, { "target": "com.amazonaws.iotsitewise#InternalFailureException" }, @@ -6756,24 +7515,24 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a dashboard from IoT SiteWise Monitor.

", + "smithy.api#documentation": "

Deletes a computation model. This action can't be undone.

", "smithy.api#endpoint": { - "hostPrefix": "monitor." + "hostPrefix": "api." }, "smithy.api#http": { "method": "DELETE", - "uri": "/dashboards/{dashboardId}", - "code": 204 + "uri": "/computation-models/{computationModelId}", + "code": 202 } } }, - "com.amazonaws.iotsitewise#DeleteDashboardRequest": { + "com.amazonaws.iotsitewise#DeleteComputationModelRequest": { "type": "structure", "members": { - "dashboardId": { + "computationModelId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ID of the dashboard to delete.

", + "smithy.api#documentation": "

The ID of the computation model.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6791,25 +7550,30 @@ "smithy.api#input": {} } }, - "com.amazonaws.iotsitewise#DeleteDashboardResponse": { + "com.amazonaws.iotsitewise#DeleteComputationModelResponse": { "type": "structure", - "members": {}, + "members": { + "computationModelStatus": { + "target": "com.amazonaws.iotsitewise#ComputationModelStatus", + "traits": { + "smithy.api#documentation": "

The status of the computation model. It contains a state (DELETING after successfully\n calling this operation) and any error messages.

", + "smithy.api#required": {} + } + } + }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.iotsitewise#DeleteDataset": { + "com.amazonaws.iotsitewise#DeleteDashboard": { "type": "operation", "input": { - "target": "com.amazonaws.iotsitewise#DeleteDatasetRequest" + "target": "com.amazonaws.iotsitewise#DeleteDashboardRequest" }, "output": { - "target": "com.amazonaws.iotsitewise#DeleteDatasetResponse" + "target": "com.amazonaws.iotsitewise#DeleteDashboardResponse" }, "errors": [ - { - "target": "com.amazonaws.iotsitewise#ConflictingOperationException" - }, { "target": "com.amazonaws.iotsitewise#InternalFailureException" }, @@ -6824,14 +7588,82 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a dataset. This cannot be undone.

", + "smithy.api#documentation": "

Deletes a dashboard from IoT SiteWise Monitor.

", "smithy.api#endpoint": { - "hostPrefix": "api." + "hostPrefix": "monitor." }, "smithy.api#http": { "method": "DELETE", - "uri": "/datasets/{datasetId}", - "code": 202 + "uri": "/dashboards/{dashboardId}", + "code": 204 + } + } + }, + "com.amazonaws.iotsitewise#DeleteDashboardRequest": { + "type": "structure", + "members": { + "dashboardId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#DeleteDashboardResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iotsitewise#DeleteDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#DeleteDatasetRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#DeleteDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#ConflictingOperationException" + }, + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a dataset. This cannot be undone.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "DELETE", + "uri": "/datasets/{datasetId}", + "code": 202 } } }, @@ -6839,7 +7671,7 @@ "type": "structure", "members": { "datasetId": { - "target": "com.amazonaws.iotsitewise#CustomID", + "target": "com.amazonaws.iotsitewise#ID", "traits": { "smithy.api#documentation": "

The ID of the dataset.

", "smithy.api#httpLabel": {}, @@ -7338,6 +8170,12 @@ "smithy.api#documentation": "

The time the action was executed.

", "smithy.api#required": {} } + }, + "resolveTo": { + "target": "com.amazonaws.iotsitewise#ResolveTo", + "traits": { + "smithy.api#documentation": "

The detailed resource this action resolves to.

" + } } }, "traits": { @@ -7573,7 +8411,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about an asset model.

", + "smithy.api#documentation": "

Retrieves information about an asset model. This includes details about the asset model's\n properties, hierarchies, composite models, and any interface relationships if the asset model\n implements interfaces.

", "smithy.api#endpoint": { "hostPrefix": "api." }, @@ -7769,6 +8607,100 @@ "smithy.api#output": {} } }, + "com.amazonaws.iotsitewise#DescribeAssetModelInterfaceRelationship": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#DescribeAssetModelInterfaceRelationshipRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#DescribeAssetModelInterfaceRelationshipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about an interface relationship between an asset model and an\n interface asset model.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/asset-models/{assetModelId}/interface/{interfaceAssetModelId}/asset-model-interface-relationship", + "code": 200 + } + } + }, + "com.amazonaws.iotsitewise#DescribeAssetModelInterfaceRelationshipRequest": { + "type": "structure", + "members": { + "assetModelId": { + "target": "com.amazonaws.iotsitewise#CustomID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model. This can be either the actual ID in UUID format, or else\n externalId: followed by the external ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "interfaceAssetModelId": { + "target": "com.amazonaws.iotsitewise#CustomID", + "traits": { + "smithy.api#documentation": "

The ID of the interface asset model. This can be either the actual ID in UUID format, or\n else externalId: followed by the external ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#DescribeAssetModelInterfaceRelationshipResponse": { + "type": "structure", + "members": { + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model.

", + "smithy.api#required": {} + } + }, + "interfaceAssetModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the interface asset model.

", + "smithy.api#required": {} + } + }, + "propertyMappings": { + "target": "com.amazonaws.iotsitewise#PropertyMappings", + "traits": { + "smithy.api#documentation": "

A list of property mappings between the interface asset model and the asset model where\n the interface is applied.

", + "smithy.api#required": {} + } + }, + "hierarchyMappings": { + "target": "com.amazonaws.iotsitewise#HierarchyMappings", + "traits": { + "smithy.api#documentation": "

A list of hierarchy mappings between the interface asset model and the asset model where\n the interface is applied.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iotsitewise#DescribeAssetModelRequest": { "type": "structure", "members": { @@ -7896,6 +8828,12 @@ "smithy.api#documentation": "

The version of the asset model. See \n Asset model versions in the IoT SiteWise User Guide.

" } }, + "interfaceDetails": { + "target": "com.amazonaws.iotsitewise#InterfaceDetails", + "traits": { + "smithy.api#documentation": "

A list of interface details that describe the interfaces implemented by this asset model,\n including interface asset model IDs and property mappings.

" + } + }, "eTag": { "target": "com.amazonaws.iotsitewise#ETag", "traits": { @@ -7976,6 +8914,12 @@ "smithy.api#required": {} } }, + "assetExternalId": { + "target": "com.amazonaws.iotsitewise#ExternalId", + "traits": { + "smithy.api#documentation": "

The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

" + } + }, "assetName": { "target": "com.amazonaws.iotsitewise#Name", "traits": { @@ -8001,12 +8945,6 @@ "traits": { "smithy.api#documentation": "

The composite model that declares this asset property, if this asset property exists in a\n composite model.

" } - }, - "assetExternalId": { - "target": "com.amazonaws.iotsitewise#ExternalId", - "traits": { - "smithy.api#documentation": "

The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

" - } } }, "traits": { @@ -8047,6 +8985,12 @@ "smithy.api#required": {} } }, + "assetExternalId": { + "target": "com.amazonaws.iotsitewise#ExternalId", + "traits": { + "smithy.api#documentation": "

The external ID of the asset, if any.

" + } + }, "assetArn": { "target": "com.amazonaws.iotsitewise#ARN", "traits": { @@ -8120,12 +9064,6 @@ "traits": { "smithy.api#documentation": "

The list of the immediate child custom composite model summaries for the asset.

" } - }, - "assetExternalId": { - "target": "com.amazonaws.iotsitewise#ExternalId", - "traits": { - "smithy.api#documentation": "

The external ID of the asset, if any.

" - } } }, "traits": { @@ -8265,6 +9203,232 @@ "smithy.api#output": {} } }, + "com.amazonaws.iotsitewise#DescribeComputationModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#DescribeComputationModelRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#DescribeComputationModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a computation model.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/computation-models/{computationModelId}", + "code": 200 + } + } + }, + "com.amazonaws.iotsitewise#DescribeComputationModelExecutionSummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#DescribeComputationModelExecutionSummaryRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#DescribeComputationModelExecutionSummaryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the execution summary of a computation model.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/computation-models/{computationModelId}/execution-summary", + "code": 200 + } + } + }, + "com.amazonaws.iotsitewise#DescribeComputationModelExecutionSummaryRequest": { + "type": "structure", + "members": { + "computationModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the computation model.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resolveToResourceType": { + "target": "com.amazonaws.iotsitewise#ResolveToResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resolved resource.

", + "smithy.api#httpQuery": "resolveToResourceType" + } + }, + "resolveToResourceId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the resolved resource.

", + "smithy.api#httpQuery": "resolveToResourceId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#DescribeComputationModelExecutionSummaryResponse": { + "type": "structure", + "members": { + "computationModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the computation model.

", + "smithy.api#required": {} + } + }, + "resolveTo": { + "target": "com.amazonaws.iotsitewise#ResolveTo", + "traits": { + "smithy.api#documentation": "

The detailed resource this execution summary resolves to.

" + } + }, + "computationModelExecutionSummary": { + "target": "com.amazonaws.iotsitewise#ComputationModelExecutionSummary", + "traits": { + "smithy.api#documentation": "

Contains the execution summary of the computation model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iotsitewise#DescribeComputationModelRequest": { + "type": "structure", + "members": { + "computationModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the computation model.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#DescribeComputationModelResponse": { + "type": "structure", + "members": { + "computationModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the computation model.

", + "smithy.api#required": {} + } + }, + "computationModelArn": { + "target": "com.amazonaws.iotsitewise#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the computation model, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}\n

", + "smithy.api#required": {} + } + }, + "computationModelName": { + "target": "com.amazonaws.iotsitewise#RestrictedName", + "traits": { + "smithy.api#documentation": "

The name of the computation model.

", + "smithy.api#required": {} + } + }, + "computationModelDescription": { + "target": "com.amazonaws.iotsitewise#RestrictedDescription", + "traits": { + "smithy.api#documentation": "

The description of the computation model.

" + } + }, + "computationModelConfiguration": { + "target": "com.amazonaws.iotsitewise#ComputationModelConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the computation model.

", + "smithy.api#required": {} + } + }, + "computationModelDataBinding": { + "target": "com.amazonaws.iotsitewise#ComputationModelDataBinding", + "traits": { + "smithy.api#documentation": "

The data binding for the computation model. Key is a variable name defined in configuration. \n Value is a ComputationModelDataBindingValue referenced by the variable.

", + "smithy.api#required": {} + } + }, + "computationModelCreationDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The model creation date, in Unix epoch time.

", + "smithy.api#required": {} + } + }, + "computationModelLastUpdateDate": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the model was last updated, in Unix epoch time.

", + "smithy.api#required": {} + } + }, + "computationModelStatus": { + "target": "com.amazonaws.iotsitewise#ComputationModelStatus", + "traits": { + "smithy.api#documentation": "

The current status of the asset model, which contains a state and an error message if\n any.

", + "smithy.api#required": {} + } + }, + "computationModelVersion": { + "target": "com.amazonaws.iotsitewise#Version", + "traits": { + "smithy.api#documentation": "

The version of the computation model.

", + "smithy.api#required": {} + } + }, + "actionDefinitions": { + "target": "com.amazonaws.iotsitewise#ActionDefinitions", + "traits": { + "smithy.api#documentation": "

The available actions for this computation model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iotsitewise#DescribeDashboard": { "type": "operation", "input": { @@ -8416,7 +9580,7 @@ "type": "structure", "members": { "datasetId": { - "target": "com.amazonaws.iotsitewise#CustomID", + "target": "com.amazonaws.iotsitewise#ID", "traits": { "smithy.api#documentation": "

The ID of the dataset.

", "smithy.api#httpLabel": {}, @@ -8529,35 +9693,163 @@ } } }, - "com.amazonaws.iotsitewise#DescribeDefaultEncryptionConfigurationRequest": { + "com.amazonaws.iotsitewise#DescribeDefaultEncryptionConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#DescribeDefaultEncryptionConfigurationResponse": { + "type": "structure", + "members": { + "encryptionType": { + "target": "com.amazonaws.iotsitewise#EncryptionType", + "traits": { + "smithy.api#documentation": "

The type of encryption used for the encryption configuration.

", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.iotsitewise#ARN", + "traits": { + "smithy.api#documentation": "

The key ARN of the customer managed key used for KMS encryption if you use\n KMS_BASED_ENCRYPTION.

" + } + }, + "configurationStatus": { + "target": "com.amazonaws.iotsitewise#ConfigurationStatus", + "traits": { + "smithy.api#documentation": "

The status of the account configuration. This contains the\n ConfigurationState. If there's an error, it also contains the\n ErrorDetails.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iotsitewise#DescribeExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#DescribeExecutionRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#DescribeExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the execution.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/executions/{executionId}", + "code": 200 + } + } + }, + "com.amazonaws.iotsitewise#DescribeExecutionRequest": { "type": "structure", - "members": {}, + "members": { + "executionId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the execution.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.iotsitewise#DescribeDefaultEncryptionConfigurationResponse": { + "com.amazonaws.iotsitewise#DescribeExecutionResponse": { "type": "structure", "members": { - "encryptionType": { - "target": "com.amazonaws.iotsitewise#EncryptionType", + "executionId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The type of encryption used for the encryption configuration.

", + "smithy.api#documentation": "

The ID of the execution.

", "smithy.api#required": {} } }, - "kmsKeyArn": { - "target": "com.amazonaws.iotsitewise#ARN", + "actionType": { + "target": "com.amazonaws.iotsitewise#Name", "traits": { - "smithy.api#documentation": "

The key ARN of the customer managed key used for KMS encryption if you use\n KMS_BASED_ENCRYPTION.

" + "smithy.api#documentation": "

The type of action exectued.

" } }, - "configurationStatus": { - "target": "com.amazonaws.iotsitewise#ConfigurationStatus", + "targetResource": { + "target": "com.amazonaws.iotsitewise#TargetResource", "traits": { - "smithy.api#documentation": "

The status of the account configuration. This contains the\n ConfigurationState. If there's an error, it also contains the\n ErrorDetails.

", "smithy.api#required": {} } + }, + "targetResourceVersion": { + "target": "com.amazonaws.iotsitewise#Version", + "traits": { + "smithy.api#documentation": "

The version of the target resource.

", + "smithy.api#required": {} + } + }, + "resolveTo": { + "target": "com.amazonaws.iotsitewise#ResolveTo", + "traits": { + "smithy.api#documentation": "

The detailed resource this execution resolves to.

" + } + }, + "executionStartTime": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the process started.

", + "smithy.api#required": {} + } + }, + "executionEndTime": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the process ended.

" + } + }, + "executionStatus": { + "target": "com.amazonaws.iotsitewise#ExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the execution process.

", + "smithy.api#required": {} + } + }, + "executionResult": { + "target": "com.amazonaws.iotsitewise#ExecutionResult", + "traits": { + "smithy.api#documentation": "

The result of the execution.

" + } + }, + "executionDetails": { + "target": "com.amazonaws.iotsitewise#ExecutionDetails", + "traits": { + "smithy.api#documentation": "

Provides detailed information about the execution of your anomaly detection models. This\n includes model metrics and training timestamps for both training and inference actions.

\n
    \n
  • \n

    The training action (Amazon Web Services/ANOMALY_DETECTION_TRAINING), includes performance metrics\n that help you compare different versions of your anomaly detection models. These metrics\n provide insights into the model's performance during the training process.

    \n
    • \n
  • \n

    The inference action (Amazon Web Services/ANOMALY_DETECTION_INFERENCE), includes information about\n the results of executing your anomaly detection models. This helps you understand the\n output of your models and assess their performance.

    \n
    • \n
" + } + }, + "executionEntityVersion": { + "target": "com.amazonaws.iotsitewise#Version", + "traits": { + "smithy.api#documentation": "

Entity version used for the execution.

" + } } }, "traits": { @@ -8621,7 +9913,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a gateway capability configuration.\n Each gateway capability defines data sources for a gateway. A capability configuration\n can contain multiple data source configurations. If you define OPC-UA sources for a gateway in\n the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To\n list all capability configurations for a gateway, use DescribeGateway.

", + "smithy.api#documentation": "

Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.

\n

. The namespace follows the format service:capability:version, where:

\n
    \n
  • \n

    \n service - The service providing the capability, or iotsitewise.

    \n
    • \n
  • \n

    \n capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.

    \n
    • \n
  • \n

    \n version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.

    \n
    • \n
\n

After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.

\n

A gateway can have multiple capability configurations with different namespaces.

", "smithy.api#endpoint": { "hostPrefix": "api." }, @@ -8646,7 +9938,7 @@ "capabilityNamespace": { "target": "com.amazonaws.iotsitewise#CapabilityNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the capability configuration.\n For example, if you configure OPC-UA\n sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace\n iotsitewise:opcuacollector:version, where version is a number such as\n 1.

", + "smithy.api#documentation": "

The namespace of the capability configuration.\n For example, if you configure OPC UA\n sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace\n iotsitewise:opcuacollector:3.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8683,7 +9975,7 @@ "capabilitySyncStatus": { "target": "com.amazonaws.iotsitewise#CapabilitySyncStatus", "traits": { - "smithy.api#documentation": "

The synchronization status of the capability configuration. The sync status can be one of the following:

\n
    \n
  • \n

    \n IN_SYNC – The gateway is running the capability configuration.

    \n
    • \n
  • \n

    \n NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

    \n
    • \n
  • \n

    \n OUT_OF_SYNC – The gateway hasn't received the capability configuration.

    \n
    • \n
  • \n

    \n SYNC_FAILED – The gateway rejected the capability configuration.

    \n
    • \n
  • \n

    \n UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

    \n
    • \n
", + "smithy.api#documentation": "

The synchronization status of the gateway capability configuration. The sync status can be one of the following:

\n
    \n
  • \n

    \n IN_SYNC - The gateway is running with the latest configuration.

    \n
    • \n
  • \n

    \n OUT_OF_SYNC - The gateway hasn't received the latest configuration.

    \n
    • \n
  • \n

    \n SYNC_FAILED - The gateway rejected the latest configuration.

    \n
    • \n
  • \n

    \n UNKNOWN - The gateway hasn't reported its sync status.

    \n
    • \n
  • \n

    \n NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

    \n
    • \n
", "smithy.api#required": {} } } @@ -9231,7 +10523,7 @@ "disallowIngestNullNaN": { "target": "com.amazonaws.iotsitewise#DisallowIngestNullNaN", "traits": { - "smithy.api#documentation": "

Describes the configuration for ingesting NULL and NaN data. \n By default the feature is allowed. The feature is disallowed if the value is true.

" + "smithy.api#documentation": "

Describes the configuration for ingesting NULL and NaN data. By default the feature is\n allowed. The feature is disallowed if the value is true.

" } } }, @@ -9789,6 +11081,12 @@ "traits": { "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

" } + }, + "resolveTo": { + "target": "com.amazonaws.iotsitewise#ResolveTo", + "traits": { + "smithy.api#documentation": "

The detailed resource this action resolves to.

" + } } }, "traits": { @@ -9895,7 +11193,7 @@ "maxResults": { "target": "com.amazonaws.iotsitewise#ExecuteQueryMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

" + "smithy.api#documentation": "

The maximum number of results to return at one time.

\n
    \n
  • \n

    Minimum is 1

    \n
    • \n
  • \n

    Maximum is 20000

    \n
    • \n
  • \n

    Default is 250

    \n
    • \n
" } }, "clientToken": { @@ -9936,11 +11234,163 @@ "smithy.api#output": {} } }, + "com.amazonaws.iotsitewise#ExecutionDetails": { + "type": "map", + "key": { + "target": "com.amazonaws.iotsitewise#ExecutionDetailsKey" + }, + "value": { + "target": "com.amazonaws.iotsitewise#ExecutionDetailsValue" + } + }, + "com.amazonaws.iotsitewise#ExecutionDetailsKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9 _\\-#$*!@]+$" + } + }, + "com.amazonaws.iotsitewise#ExecutionDetailsValue": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9 _\\-#$*!@]+$" + } + }, + "com.amazonaws.iotsitewise#ExecutionResult": { + "type": "map", + "key": { + "target": "com.amazonaws.iotsitewise#ExecutionResultKey" + }, + "value": { + "target": "com.amazonaws.iotsitewise#ExecutionResultValue" + } + }, + "com.amazonaws.iotsitewise#ExecutionResultKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9 _\\-#$*!@]+$" + } + }, + "com.amazonaws.iotsitewise#ExecutionResultValue": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9 _\\-#$*!@]+$" + } + }, + "com.amazonaws.iotsitewise#ExecutionState": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.iotsitewise#ExecutionStatus": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.iotsitewise#ExecutionState", + "traits": { + "smithy.api#documentation": "

The current state of the computation model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the execution.

" + } + }, + "com.amazonaws.iotsitewise#ExecutionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#ExecutionSummary" + } + }, + "com.amazonaws.iotsitewise#ExecutionSummary": { + "type": "structure", + "members": { + "executionId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the execution.

", + "smithy.api#required": {} + } + }, + "actionType": { + "target": "com.amazonaws.iotsitewise#Name", + "traits": { + "smithy.api#documentation": "

The type of action exectued.

" + } + }, + "targetResource": { + "target": "com.amazonaws.iotsitewise#TargetResource", + "traits": { + "smithy.api#required": {} + } + }, + "targetResourceVersion": { + "target": "com.amazonaws.iotsitewise#Version", + "traits": { + "smithy.api#documentation": "

The version of the target resource.

", + "smithy.api#required": {} + } + }, + "resolveTo": { + "target": "com.amazonaws.iotsitewise#ResolveTo", + "traits": { + "smithy.api#documentation": "

The detailed resource this execution resolves to.

" + } + }, + "executionStartTime": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the process started.

", + "smithy.api#required": {} + } + }, + "executionEndTime": { + "target": "com.amazonaws.iotsitewise#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the process ended.

" + } + }, + "executionStatus": { + "target": "com.amazonaws.iotsitewise#ExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the execution process.

", + "smithy.api#required": {} + } + }, + "executionEntityVersion": { + "target": "com.amazonaws.iotsitewise#Version", + "traits": { + "smithy.api#documentation": "

The execution entity version associated with the summary.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the execution summary of the computation model.

" + } + }, "com.amazonaws.iotsitewise#Expression": { "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 1024 } } @@ -10081,14 +11531,14 @@ "capabilityNamespace": { "target": "com.amazonaws.iotsitewise#CapabilityNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the capability configuration.\n For example, if you configure OPC-UA\n sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace\n iotsitewise:opcuacollector:version, where version is a number such as\n 1.

", + "smithy.api#documentation": "

The namespace of the capability configuration.\n For example, if you configure OPC UA\n sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace\n iotsitewise:opcuacollector:3.

", "smithy.api#required": {} } }, "capabilitySyncStatus": { "target": "com.amazonaws.iotsitewise#CapabilitySyncStatus", "traits": { - "smithy.api#documentation": "

The synchronization status of the capability configuration. The sync status can be one of the following:

\n
    \n
  • \n

    \n IN_SYNC – The gateway is running the capability configuration.

    \n
    • \n
  • \n

    \n NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

    \n
    • \n
  • \n

    \n OUT_OF_SYNC – The gateway hasn't received the capability configuration.

    \n
    • \n
  • \n

    \n SYNC_FAILED – The gateway rejected the capability configuration.

    \n
    • \n
  • \n

    \n UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

    \n
    • \n
", + "smithy.api#documentation": "

The synchronization status of the gateway capability configuration. The sync status can be one of the following:

\n
    \n
  • \n

    \n IN_SYNC - The gateway is running with the latest configuration.

    \n
    • \n
  • \n

    \n OUT_OF_SYNC - The gateway hasn't received the latest configuration.

    \n
    • \n
  • \n

    \n SYNC_FAILED - The gateway rejected the latest configuration.

    \n
    • \n
  • \n

    \n UNKNOWN - The gateway hasn't reported its sync status.

    \n
    • \n
  • \n

    \n NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

    \n
    • \n
", "smithy.api#required": {} } } @@ -10130,7 +11580,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains a gateway's platform information.

" + "smithy.api#documentation": "

The gateway's platform configuration. You can only specify one platform type in a\n gateway.

\n

(Legacy only) For Greengrass V1 gateways, specify the greengrass parameter\n with a valid Greengrass group ARN.

\n

For Greengrass V2 gateways, specify the greengrassV2 parameter with a valid\n core device thing name. If creating a V3 gateway (gatewayVersion=3), you must\n also specify the coreDeviceOperatingSystem.

\n

For Siemens Industrial Edge gateways, specify the siemensIE parameter with a\n valid IoT Core thing name.

" } }, "com.amazonaws.iotsitewise#GatewaySummaries": { @@ -10193,6 +11643,7 @@ "com.amazonaws.iotsitewise#GatewayVersion": { "type": "string", "traits": { + "smithy.api#documentation": "

The version of the gateway. Options include:

\n
    \n
  • \n

    \n 2 - Classic streams, V2 gateway.

    \n
    • \n
  • \n

    \n 3 - MQTT-enabled, V3 gateway.

    \n
    • \n
", "smithy.api#length": { "min": 1, "max": 1024 @@ -10780,7 +12231,7 @@ "coreDeviceOperatingSystem": { "target": "com.amazonaws.iotsitewise#CoreDeviceOperatingSystem", "traits": { - "smithy.api#documentation": "

The operating system of the core device in IoT Greengrass V2.

" + "smithy.api#documentation": "

The operating system of the core device in IoT Greengrass V2. Specifying the operating system is\n required for MQTT-enabled, V3 gateways (gatewayVersion\n 3) and not applicable for Classic stream, V2 gateways\n (gatewayVersion\n 2).

" } } }, @@ -10803,6 +12254,34 @@ "smithy.api#documentation": "

Contains information for a group identity in an access policy.

" } }, + "com.amazonaws.iotsitewise#HierarchyMapping": { + "type": "structure", + "members": { + "assetModelHierarchyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the hierarchy in the asset model where the interface is applied.

", + "smithy.api#required": {} + } + }, + "interfaceAssetModelHierarchyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the hierarchy in the interface asset model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Maps a hierarchy from an interface asset model to a hierarchy in the asset model where the\n interface is applied.

" + } + }, + "com.amazonaws.iotsitewise#HierarchyMappings": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#HierarchyMapping" + } + }, "com.amazonaws.iotsitewise#IAMRoleIdentity": { "type": "structure", "members": { @@ -10840,7 +12319,7 @@ "min": 36, "max": 36 }, - "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + "smithy.api#pattern": "^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.iotsitewise#IDs": { @@ -10989,26 +12468,106 @@ } } }, - "com.amazonaws.iotsitewise#ImageLocation": { + "com.amazonaws.iotsitewise#ImageLocation": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the image.

", + "smithy.api#required": {} + } + }, + "url": { + "target": "com.amazonaws.iotsitewise#Url", + "traits": { + "smithy.api#documentation": "

The URL where the image is available. The URL is valid for 15 minutes so that you can view\n and download the image

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains an image that is uploaded to IoT SiteWise and available at a URL.

" + } + }, + "com.amazonaws.iotsitewise#InputProperties": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 67 + }, + "smithy.api#pattern": "^\\$\\{[a-z][a-z0-9_]*\\}$" + } + }, + "com.amazonaws.iotsitewise#InterfaceDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#InterfaceRelationship" + } + }, + "com.amazonaws.iotsitewise#InterfaceRelationship": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model that has the interface applied to it.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the relationship between an asset model and an interface asset\n model that is applied to it.

" + } + }, + "com.amazonaws.iotsitewise#InterfaceRelationshipSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#InterfaceRelationshipSummary" + } + }, + "com.amazonaws.iotsitewise#InterfaceRelationshipSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model that has the interface applied to it.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains summary information about an interface relationship, which defines how an\n interface is applied to an asset model. This summary provides the essential identifiers needed\n to retrieve detailed information about the relationship.

" + } + }, + "com.amazonaws.iotsitewise#InterfaceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#InterfaceSummary" + } + }, + "com.amazonaws.iotsitewise#InterfaceSummary": { "type": "structure", "members": { - "id": { + "interfaceAssetModelId": { "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ID of the image.

", + "smithy.api#documentation": "

The ID of the interface asset model that contains this property.

", "smithy.api#required": {} } }, - "url": { - "target": "com.amazonaws.iotsitewise#Url", + "interfaceAssetModelPropertyId": { + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The URL where the image is available. The URL is valid for 15 minutes so that you can view\n and download the image

", + "smithy.api#documentation": "

The ID of the property in the interface asset model that corresponds to this\n property.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains an image that is uploaded to IoT SiteWise and available at a URL.

" + "smithy.api#documentation": "

Contains summary information about an interface that a property belongs to.

" } }, "com.amazonaws.iotsitewise#InternalFailureException": { @@ -11362,7 +12921,7 @@ } }, "traits": { - "smithy.api#documentation": "

You've reached the limit for a resource. For example, this can occur if you're trying to\n associate more than the allowed number of child assets or attempting to create more than the\n allowed number of properties for an asset model.

\n

For more information, see Quotas in the IoT SiteWise User Guide.

", + "smithy.api#documentation": "

You've reached the quota for a resource. For example, this can occur if you're trying to\n associate more than the allowed number of child assets or attempting to create more than the\n allowed number of properties for an asset model.

\n

For more information, see Quotas in the IoT SiteWise User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 410 } @@ -11528,7 +13087,7 @@ } }, "targetResourceId": { - "target": "com.amazonaws.iotsitewise#CustomID", + "target": "com.amazonaws.iotsitewise#ID", "traits": { "smithy.api#documentation": "

The ID of the target resource.

", "smithy.api#httpQuery": "targetResourceId", @@ -11548,6 +13107,20 @@ "smithy.api#documentation": "

The maximum number of results to return for each paginated request.

", "smithy.api#httpQuery": "maxResults" } + }, + "resolveToResourceType": { + "target": "com.amazonaws.iotsitewise#ResolveToResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resolved resource.

", + "smithy.api#httpQuery": "resolveToResourceType" + } + }, + "resolveToResourceId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the resolved resource.

", + "smithy.api#httpQuery": "resolveToResourceId" + } } }, "traits": { @@ -11839,7 +13412,7 @@ "assetModelTypes": { "target": "com.amazonaws.iotsitewise#ListAssetModelsTypeFilter", "traits": { - "smithy.api#documentation": "

The type of asset model. If you don't provide an assetModelTypes, all types\n of asset models are returned.

\n
    \n
  • \n

    \n ASSET_MODEL – An asset model that you can use\n to create assets. Can't be included as a component in another asset model.

    \n
    • \n
  • \n

    \n COMPONENT_MODEL – A reusable component that\n you can include in the composite models of other asset models. You can't create\n assets directly from this type of asset model.

    \n
    • \n
", + "smithy.api#documentation": "

The type of asset model. If you don't provide an assetModelTypes, all types\n of asset models are returned.

\n
    \n
  • \n

    \n ASSET_MODEL – An asset model that you can use\n to create assets. Can't be included as a component in another asset model.

    \n
    • \n
  • \n

    \n COMPONENT_MODEL – A reusable component that\n you can include in the composite models of other asset models. You can't create\n assets directly from this type of asset model.

    \n
    • \n
  • \n

    \n INTERFACE – An interface is a type of model\n that defines a standard structure that can be applied to different asset models.

    \n
    • \n
", "smithy.api#httpQuery": "assetModelTypes" } }, @@ -12469,10 +14042,277 @@ "com.amazonaws.iotsitewise#ListCompositionRelationships": { "type": "operation", "input": { - "target": "com.amazonaws.iotsitewise#ListCompositionRelationshipsRequest" + "target": "com.amazonaws.iotsitewise#ListCompositionRelationshipsRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#ListCompositionRelationshipsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a paginated list of composition relationships for an asset model of type\n COMPONENT_MODEL.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/asset-models/{assetModelId}/composition-relationships", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "compositionRelationshipSummaries", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotsitewise#ListCompositionRelationshipsRequest": { + "type": "structure", + "members": { + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token to be used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for each paginated request.

\n

Default: 50

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#ListCompositionRelationshipsResponse": { + "type": "structure", + "members": { + "compositionRelationshipSummaries": { + "target": "com.amazonaws.iotsitewise#CompositionRelationshipSummaries", + "traits": { + "smithy.api#documentation": "

A list that summarizes each composition relationship.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iotsitewise#ListComputationModelDataBindingUsages": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#ListComputationModelDataBindingUsagesRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#ListComputationModelDataBindingUsagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all data binding usages for computation models. This allows to identify where\n specific data bindings are being utilized across the computation models. This track\n dependencies between data sources and computation models.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/computation-models/data-binding-usages", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "dataBindingUsageSummaries", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotsitewise#ListComputationModelDataBindingUsagesRequest": { + "type": "structure", + "members": { + "dataBindingValueFilter": { + "target": "com.amazonaws.iotsitewise#DataBindingValueFilter", + "traits": { + "smithy.api#documentation": "

A filter used to limit the returned data binding usages based on specific data binding\n values. You can filter by asset, asset model, asset property, or asset model property to find\n all computation models using these specific data sources.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token used for the next set of paginated results.

" + } + }, + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results returned for each paginated request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#ListComputationModelDataBindingUsagesResponse": { + "type": "structure", + "members": { + "dataBindingUsageSummaries": { + "target": "com.amazonaws.iotsitewise#ComputationModelDataBindingUsageSummaries", + "traits": { + "smithy.api#documentation": "

A list of summaries describing the data binding usages across computation models. Each\n summary includes the computation model IDs and the matched data binding details.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of paginated results, or null if there are no additional\n results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iotsitewise#ListComputationModelResolveToResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#ListComputationModelResolveToResourcesRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#ListComputationModelResolveToResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all distinct resources that are resolved from the executed actions of the\n computation model.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/computation-models/{computationModelId}/resolve-to-resources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "computationModelResolveToResourceSummaries", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotsitewise#ListComputationModelResolveToResourcesRequest": { + "type": "structure", + "members": { + "computationModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the computation model for which to list resolved resources.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results returned for each paginated request.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#ListComputationModelResolveToResourcesResponse": { + "type": "structure", + "members": { + "computationModelResolveToResourceSummaries": { + "target": "com.amazonaws.iotsitewise#ComputationModelResolveToResourceSummaries", + "traits": { + "smithy.api#documentation": "

A list of summaries describing the distinct resources that this computation model resolves\n to when actions were executed.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of paginated results, or null if there are no additional\n results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iotsitewise#ListComputationModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#ListComputationModelsRequest" }, "output": { - "target": "com.amazonaws.iotsitewise#ListCompositionRelationshipsResponse" + "target": "com.amazonaws.iotsitewise#ListComputationModelsResponse" }, "errors": [ { @@ -12481,40 +14321,36 @@ { "target": "com.amazonaws.iotsitewise#InvalidRequestException" }, - { - "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" - }, { "target": "com.amazonaws.iotsitewise#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

Retrieves a paginated list of composition relationships for an asset model of type\n COMPONENT_MODEL.

", + "smithy.api#documentation": "

Retrieves a paginated list of summaries of all computation models.

", "smithy.api#endpoint": { "hostPrefix": "api." }, "smithy.api#http": { "method": "GET", - "uri": "/asset-models/{assetModelId}/composition-relationships", + "uri": "/computation-models", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "compositionRelationshipSummaries", + "items": "computationModelSummaries", "pageSize": "maxResults" } } }, - "com.amazonaws.iotsitewise#ListCompositionRelationshipsRequest": { + "com.amazonaws.iotsitewise#ListComputationModelsRequest": { "type": "structure", "members": { - "assetModelId": { - "target": "com.amazonaws.iotsitewise#ID", + "computationModelType": { + "target": "com.amazonaws.iotsitewise#ComputationModelType", "traits": { - "smithy.api#documentation": "

The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one.\n For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The type of computation model. If a computationModelType is not provided, all\n types of computation models are returned.

", + "smithy.api#httpQuery": "computationModelType" } }, "nextToken": { @@ -12527,7 +14363,7 @@ "maxResults": { "target": "com.amazonaws.iotsitewise#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return for each paginated request.

\n

Default: 50

", + "smithy.api#documentation": "

The maximum number of results to return for each paginated request.

", "smithy.api#httpQuery": "maxResults" } } @@ -12536,13 +14372,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.iotsitewise#ListCompositionRelationshipsResponse": { + "com.amazonaws.iotsitewise#ListComputationModelsResponse": { "type": "structure", "members": { - "compositionRelationshipSummaries": { - "target": "com.amazonaws.iotsitewise#CompositionRelationshipSummaries", + "computationModelSummaries": { + "target": "com.amazonaws.iotsitewise#ComputationModelSummaries", "traits": { - "smithy.api#documentation": "

A list that summarizes each composition relationship.

", + "smithy.api#documentation": "

A list summarizing each computation model.

", "smithy.api#required": {} } }, @@ -12733,6 +14569,126 @@ "smithy.api#output": {} } }, + "com.amazonaws.iotsitewise#ListExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#ListExecutionsRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#ListExecutionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a paginated list of summaries of all executions.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/executions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "executionSummaries", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotsitewise#ListExecutionsRequest": { + "type": "structure", + "members": { + "targetResourceType": { + "target": "com.amazonaws.iotsitewise#TargetResourceType", + "traits": { + "smithy.api#documentation": "

The type of the target resource.

", + "smithy.api#httpQuery": "targetResourceType", + "smithy.api#required": {} + } + }, + "targetResourceId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the target resource.

", + "smithy.api#httpQuery": "targetResourceId", + "smithy.api#required": {} + } + }, + "resolveToResourceType": { + "target": "com.amazonaws.iotsitewise#ResolveToResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resolved resource.

", + "smithy.api#httpQuery": "resolveToResourceType" + } + }, + "resolveToResourceId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the resolved resource.

", + "smithy.api#httpQuery": "resolveToResourceId" + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results returned for each paginated request.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "actionType": { + "target": "com.amazonaws.iotsitewise#Name", + "traits": { + "smithy.api#documentation": "

The type of action exectued.

", + "smithy.api#httpQuery": "actionType" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#ListExecutionsResponse": { + "type": "structure", + "members": { + "executionSummaries": { + "target": "com.amazonaws.iotsitewise#ExecutionSummaries", + "traits": { + "smithy.api#documentation": "

Contains the list of execution summaries of the computation models.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iotsitewise#ListGateways": { "type": "operation", "input": { @@ -12813,6 +14769,97 @@ "smithy.api#output": {} } }, + "com.amazonaws.iotsitewise#ListInterfaceRelationships": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#ListInterfaceRelationshipsRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#ListInterfaceRelationshipsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a paginated list of asset models that have a specific interface asset model\n applied to them.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/interface/{interfaceAssetModelId}/asset-models", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "interfaceRelationshipSummaries", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotsitewise#ListInterfaceRelationshipsRequest": { + "type": "structure", + "members": { + "interfaceAssetModelId": { + "target": "com.amazonaws.iotsitewise#CustomID", + "traits": { + "smithy.api#documentation": "

The ID of the interface asset model. This can be either the actual ID in UUID format, or\n else externalId: followed by the external ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token to be used for the next set of paginated results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.iotsitewise#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return for each paginated request. Default: 50

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#ListInterfaceRelationshipsResponse": { + "type": "structure", + "members": { + "interfaceRelationshipSummaries": { + "target": "com.amazonaws.iotsitewise#InterfaceRelationshipSummaries", + "traits": { + "smithy.api#documentation": "

A list that summarizes each interface relationship.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iotsitewise#ListPortals": { "type": "operation", "input": { @@ -13324,6 +15371,27 @@ "smithy.api#pattern": "^[^\\u0000-\\u001F\\u007F]+$" } }, + "com.amazonaws.iotsitewise#MatchByPropertyName": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.iotsitewise#MatchedDataBinding": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.iotsitewise#DataBindingValue", + "traits": { + "smithy.api#documentation": "

The value of the matched data binding.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a data binding that matches the specified filter criteria.

" + } + }, "com.amazonaws.iotsitewise#MaxInterpolatedResults": { "type": "integer", "traits": { @@ -13386,15 +15454,17 @@ "expression": { "target": "com.amazonaws.iotsitewise#Expression", "traits": { - "smithy.api#documentation": "

The mathematical expression that defines the metric aggregation function. You can specify\n up to 10 variables per expression. You can specify up to 10 functions\n per expression.

\n

For more information, see Quotas in the IoT SiteWise User Guide.

", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": "", + "smithy.api#documentation": "

The mathematical expression that defines the metric aggregation function. You can specify\n up to 10 variables per expression. You can specify up to 10 functions\n per expression.

\n

For more information, see Quotas in the IoT SiteWise User Guide.

" } }, "variables": { "target": "com.amazonaws.iotsitewise#ExpressionVariables", "traits": { - "smithy.api#documentation": "

The list of variables used in the expression.

", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": [], + "smithy.api#documentation": "

The list of variables used in the expression.

" } }, "window": { @@ -13887,6 +15957,12 @@ "smithy.api#required": {} } }, + "externalId": { + "target": "com.amazonaws.iotsitewise#ExternalId", + "traits": { + "smithy.api#documentation": "

The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.

" + } + }, "name": { "target": "com.amazonaws.iotsitewise#Name", "traits": { @@ -13930,12 +16006,6 @@ "traits": { "smithy.api#documentation": "

The structured path to the property from the root of the asset.

" } - }, - "externalId": { - "target": "com.amazonaws.iotsitewise#ExternalId", - "traits": { - "smithy.api#documentation": "

The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.

" - } } }, "traits": { @@ -13969,21 +16039,77 @@ "DOUBLE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DOUBLE" + "smithy.api#enumValue": "DOUBLE" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + }, + "STRUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRUCT" + } + } + } + }, + "com.amazonaws.iotsitewise#PropertyMapping": { + "type": "structure", + "members": { + "assetModelPropertyId": { + "target": "com.amazonaws.iotsitewise#CustomID", + "traits": { + "smithy.api#documentation": "

The ID of the property in the asset model where the interface is applied.

", + "smithy.api#required": {} + } + }, + "interfaceAssetModelPropertyId": { + "target": "com.amazonaws.iotsitewise#CustomID", + "traits": { + "smithy.api#documentation": "

The ID of the property in the interface asset model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Maps a property from an interface asset model to a property in the asset model where the\n interface is applied.

" + } + }, + "com.amazonaws.iotsitewise#PropertyMappingConfiguration": { + "type": "structure", + "members": { + "matchByPropertyName": { + "target": "com.amazonaws.iotsitewise#MatchByPropertyName", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If true, properties are matched by name between the interface asset model and the asset\n model where the interface is applied.

" } }, - "BOOLEAN": { - "target": "smithy.api#Unit", + "createMissingProperty": { + "target": "com.amazonaws.iotsitewise#CreateMissingProperty", "traits": { - "smithy.api#enumValue": "BOOLEAN" + "smithy.api#default": false, + "smithy.api#documentation": "

If true, missing properties from the interface asset model are automatically created in\n the asset model where the interface is applied.

" } }, - "STRUCT": { - "target": "smithy.api#Unit", + "overrides": { + "target": "com.amazonaws.iotsitewise#PropertyMappings", "traits": { - "smithy.api#enumValue": "STRUCT" + "smithy.api#documentation": "

A list of specific property mappings that override the automatic mapping by name when an\n interface is applied to an asset model.

" } } + }, + "traits": { + "smithy.api#documentation": "

Contains configuration options for mapping properties from an interface asset model to an\n asset model where the interface is applied.

" + } + }, + "com.amazonaws.iotsitewise#PropertyMappings": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#PropertyMapping" } }, "com.amazonaws.iotsitewise#PropertyNotification": { @@ -14097,6 +16223,119 @@ "com.amazonaws.iotsitewise#PropertyValueStringValue": { "type": "string" }, + "com.amazonaws.iotsitewise#PutAssetModelInterfaceRelationship": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#PutAssetModelInterfaceRelationshipRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#PutAssetModelInterfaceRelationshipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#ConflictingOperationException" + }, + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates an interface relationship between an asset model and an interface asset\n model. This operation applies an interface to an asset model.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "PUT", + "uri": "/asset-models/{assetModelId}/interface/{interfaceAssetModelId}/asset-model-interface-relationship", + "code": 202 + } + } + }, + "com.amazonaws.iotsitewise#PutAssetModelInterfaceRelationshipRequest": { + "type": "structure", + "members": { + "assetModelId": { + "target": "com.amazonaws.iotsitewise#CustomID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model. This can be either the actual ID in UUID format, or else\n externalId: followed by the external ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "interfaceAssetModelId": { + "target": "com.amazonaws.iotsitewise#CustomID", + "traits": { + "smithy.api#documentation": "

The ID of the interface asset model. This can be either the actual ID in UUID format, or\n else externalId: followed by the external ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "propertyMappingConfiguration": { + "target": "com.amazonaws.iotsitewise#PropertyMappingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for mapping properties from the interface asset model to the asset model\n where the interface is applied. This configuration controls how properties are matched and\n created during the interface application process.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the\n request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#PutAssetModelInterfaceRelationshipResponse": { + "type": "structure", + "members": { + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model.

", + "smithy.api#required": {} + } + }, + "interfaceAssetModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the interface asset model.

", + "smithy.api#required": {} + } + }, + "assetModelArn": { + "target": "com.amazonaws.iotsitewise#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the asset model, which has the following format.\n arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}\n

", + "smithy.api#required": {} + } + }, + "assetModelStatus": { + "target": "com.amazonaws.iotsitewise#AssetModelStatus", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iotsitewise#PutAssetPropertyValueEntries": { "type": "list", "member": { @@ -14371,7 +16610,7 @@ "disallowIngestNullNaN": { "target": "com.amazonaws.iotsitewise#DisallowIngestNullNaN", "traits": { - "smithy.api#documentation": "

Describes the configuration for ingesting NULL and NaN data. \n By default the feature is allowed. The feature is disallowed if the value is true.

" + "smithy.api#documentation": "

Describes the configuration for ingesting NULL and NaN data. By default the feature is\n allowed. The feature is disallowed if the value is true.

" } } }, @@ -14425,7 +16664,7 @@ "disallowIngestNullNaN": { "target": "com.amazonaws.iotsitewise#DisallowIngestNullNaN", "traits": { - "smithy.api#documentation": "

Describes the configuration for ingesting NULL and NaN data. \n By default the feature is allowed. The feature is disallowed if the value is true.

" + "smithy.api#documentation": "

Describes the configuration for ingesting NULL and NaN data. By default the feature is\n allowed. The feature is disallowed if the value is true.

" } } }, @@ -14549,6 +16788,32 @@ "smithy.api#pattern": "^1m|15m|1h|1d$" } }, + "com.amazonaws.iotsitewise#ResolveTo": { + "type": "structure", + "members": { + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset that the resource resolves to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The detailed resource this execution summary resolves to.

" + } + }, + "com.amazonaws.iotsitewise#ResolveToResourceType": { + "type": "enum", + "members": { + "ASSET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSET" + } + } + } + }, "com.amazonaws.iotsitewise#Resource": { "type": "structure", "members": { @@ -14700,6 +16965,16 @@ "smithy.api#pattern": "^[a-zA-Z0-9 _\\-#$*!@]+$" } }, + "com.amazonaws.iotsitewise#ResultProperty": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 67 + }, + "smithy.api#pattern": "^\\$\\{[a-z][a-z0-9_]*\\}$" + } + }, "com.amazonaws.iotsitewise#RetentionPeriod": { "type": "structure", "members": { @@ -15005,15 +17280,20 @@ "type": "structure", "members": { "assetId": { - "target": "com.amazonaws.iotsitewise#CustomID", + "target": "com.amazonaws.iotsitewise#ID", "traits": { - "smithy.api#documentation": "

The ID of the asset, in UUID format.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The ID of the asset, in UUID format.

" + } + }, + "computationModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the computation model.

" } } }, "traits": { - "smithy.api#documentation": "

The resource the action will be taken on.

" + "smithy.api#documentation": "

The resource the action will be taken on. This can include asset-based resources and\n computation model resources.

" } }, "com.amazonaws.iotsitewise#TargetResourceType": { @@ -15024,6 +17304,12 @@ "traits": { "smithy.api#enumValue": "ASSET" } + }, + "COMPUTATION_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPUTATION_MODEL" + } } } }, @@ -15195,7 +17481,7 @@ } }, "traits": { - "smithy.api#documentation": "

You've reached the limit for the number of tags allowed for a resource. For more\n information, see Tag naming limits and\n requirements in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

You've reached the quota for the number of tags allowed for a resource. For more\n information, see Tag naming limits and\n requirements in the Amazon Web Services General Reference.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15910,6 +18196,12 @@ "smithy.api#required": {} } }, + "assetExternalId": { + "target": "com.amazonaws.iotsitewise#ExternalId", + "traits": { + "smithy.api#documentation": "

An external ID to assign to the asset. The asset must not already have an external ID.\n The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

" + } + }, "assetName": { "target": "com.amazonaws.iotsitewise#Name", "traits": { @@ -15929,12 +18221,6 @@ "traits": { "smithy.api#documentation": "

A description for the asset.

" } - }, - "assetExternalId": { - "target": "com.amazonaws.iotsitewise#ExternalId", - "traits": { - "smithy.api#documentation": "

An external ID to assign to the asset. The asset must not already have an external ID.\n The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

" - } } }, "traits": { @@ -15956,6 +18242,114 @@ "smithy.api#output": {} } }, + "com.amazonaws.iotsitewise#UpdateComputationModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#UpdateComputationModelRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#UpdateComputationModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#ConflictingOperationException" + }, + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the computation model.

", + "smithy.api#endpoint": { + "hostPrefix": "api." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/computation-models/{computationModelId}", + "code": 202 + } + } + }, + "com.amazonaws.iotsitewise#UpdateComputationModelRequest": { + "type": "structure", + "members": { + "computationModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the computation model.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "computationModelName": { + "target": "com.amazonaws.iotsitewise#RestrictedName", + "traits": { + "smithy.api#documentation": "

The name of the computation model.

", + "smithy.api#required": {} + } + }, + "computationModelDescription": { + "target": "com.amazonaws.iotsitewise#RestrictedDescription", + "traits": { + "smithy.api#documentation": "

The description of the computation model.

" + } + }, + "computationModelConfiguration": { + "target": "com.amazonaws.iotsitewise#ComputationModelConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the computation model.

", + "smithy.api#required": {} + } + }, + "computationModelDataBinding": { + "target": "com.amazonaws.iotsitewise#ComputationModelDataBinding", + "traits": { + "smithy.api#documentation": "

The data binding for the computation model. Key is a variable name defined in configuration. \n Value is a ComputationModelDataBindingValue referenced by the variable.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the\n request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iotsitewise#UpdateComputationModelResponse": { + "type": "structure", + "members": { + "computationModelStatus": { + "target": "com.amazonaws.iotsitewise#ComputationModelStatus", + "traits": { + "smithy.api#documentation": "

The status of the computation model. It contains a state (UPDATING after successfully\n calling this operation) and an error message if any.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iotsitewise#UpdateDashboard": { "type": "operation", "input": { @@ -16084,7 +18478,7 @@ "type": "structure", "members": { "datasetId": { - "target": "com.amazonaws.iotsitewise#CustomID", + "target": "com.amazonaws.iotsitewise#ID", "traits": { "smithy.api#documentation": "

The ID of the dataset.

", "smithy.api#httpLabel": {}, @@ -16127,7 +18521,7 @@ "type": "structure", "members": { "datasetId": { - "target": "com.amazonaws.iotsitewise#CustomID", + "target": "com.amazonaws.iotsitewise#ID", "traits": { "smithy.api#documentation": "

The ID of the dataset.

" } @@ -16215,7 +18609,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a gateway capability configuration or defines a new capability configuration.\n Each gateway capability defines data sources for a gateway. A capability configuration\n can contain multiple data source configurations. If you define OPC-UA sources for a gateway in\n the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To\n list all capability configurations for a gateway, use DescribeGateway.

", + "smithy.api#documentation": "

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway.

\n

Important workflow notes:

\n

Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.

\n

. The namespace follows the format service:capability:version, where:

\n
    \n
  • \n

    \n service - The service providing the capability, or iotsitewise.

    \n
    • \n
  • \n

    \n capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.

    \n
    • \n
  • \n

    \n version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.

    \n
    • \n
\n

After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.

\n

A gateway can have multiple capability configurations with different namespaces.

", "smithy.api#endpoint": { "hostPrefix": "api." }, @@ -16240,7 +18634,7 @@ "capabilityNamespace": { "target": "com.amazonaws.iotsitewise#CapabilityNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the gateway capability configuration to be updated.\n For example, if you configure OPC-UA\n sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace\n iotsitewise:opcuacollector:version, where version is a number such as\n 1.

", + "smithy.api#documentation": "

The namespace of the gateway capability configuration to be updated.\n For example, if you configure OPC UA\n sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace\n iotsitewise:opcuacollector:3.

", "smithy.api#required": {} } }, @@ -16269,7 +18663,7 @@ "capabilitySyncStatus": { "target": "com.amazonaws.iotsitewise#CapabilitySyncStatus", "traits": { - "smithy.api#documentation": "

The synchronization status of the capability configuration. The sync status can be one of the following:

\n
    \n
  • \n

    \n IN_SYNC – The gateway is running the capability configuration.

    \n
    • \n
  • \n

    \n NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

    \n
    • \n
  • \n

    \n OUT_OF_SYNC – The gateway hasn't received the capability configuration.

    \n
    • \n
  • \n

    \n SYNC_FAILED – The gateway rejected the capability configuration.

    \n
    • \n
  • \n

    \n UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

    \n
    • \n
\n

After you update a capability configuration, its sync status is OUT_OF_SYNC\n until the gateway receives and applies or rejects the updated configuration.

", + "smithy.api#documentation": "

The synchronization status of the gateway capability configuration. The sync status can be one of the following:

\n
    \n
  • \n

    \n IN_SYNC - The gateway is running with the latest configuration.

    \n
    • \n
  • \n

    \n OUT_OF_SYNC - The gateway hasn't received the latest configuration.

    \n
    • \n
  • \n

    \n SYNC_FAILED - The gateway rejected the latest configuration.

    \n
    • \n
  • \n

    \n UNKNOWN - The gateway hasn't reported its sync status.

    \n
    • \n
  • \n

    \n NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

    \n
    • \n
\n

After you update a capability configuration, its sync status is OUT_OF_SYNC\n until the gateway receives and applies or rejects the updated configuration.

", "smithy.api#required": {} } } @@ -16587,7 +18981,7 @@ "stringValue": { "target": "com.amazonaws.iotsitewise#PropertyValueStringValue", "traits": { - "smithy.api#documentation": "

\n Asset property data of type string (sequence of characters).\n The allowed pattern: \"^$|[^\\u0000-\\u001F\\u007F]+\". The max length is 1024.\n

" + "smithy.api#documentation": "

Asset property data of type string (sequence of characters). The allowed pattern:\n \"^$|[^\\u0000-\\u001F\\u007F]+\". The max length is 1024.

" } }, "integerValue": { @@ -16599,7 +18993,7 @@ "doubleValue": { "target": "com.amazonaws.iotsitewise#PropertyValueDoubleValue", "traits": { - "smithy.api#documentation": "

\n Asset property data of type double (floating point number). The min value is -10^10. \n The max value is 10^10. Double.NaN is allowed.\n

" + "smithy.api#documentation": "

Asset property data of type double (floating point number). The min value is -10^10. The\n max value is 10^10. Double.NaN is allowed.

" } }, "booleanValue": { diff --git a/codegen/sdk/aws-models/keyspacesstreams.json b/codegen/sdk/aws-models/keyspacesstreams.json index 1529492caee..0b8ebb6437b 100644 --- a/codegen/sdk/aws-models/keyspacesstreams.json +++ b/codegen/sdk/aws-models/keyspacesstreams.json @@ -59,14 +59,14 @@ "shardIterator": { "target": "com.amazonaws.keyspacesstreams#ShardIterator", "traits": { - "smithy.api#documentation": "

The unique identifier of the shard iterator. A shard iterator specifies the position in the shard from which you want to start reading data records sequentially. You obtain this value by calling the GetShardIterator operation. Each shard iterator is valid for 5 minutes after creation.

", + "smithy.api#documentation": "

The unique identifier of the shard iterator. A shard iterator specifies the position in the shard from which you want to start reading data records sequentially. You obtain this value by calling the GetShardIterator operation. Each shard iterator is valid for 15 minutes after creation.

", "smithy.api#required": {} } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of records to return in a single GetRecords request. Default value is 1000. You can specify a limit between 1 and 10000, but the actual number returned might be less than the specified maximum if the size of the data for the returned records exceeds the internal size limit.

", + "smithy.api#documentation": "

The maximum number of records to return in a single GetRecords request. Default value is 1000. You can specify a limit between 1 and 1000, but the actual number returned might be less than the specified maximum if the size of the data for the returned records exceeds the internal size limit.

", "smithy.api#range": { "min": 1, "max": 1000 @@ -168,7 +168,7 @@ "shardIterator": { "target": "com.amazonaws.keyspacesstreams#ShardIterator", "traits": { - "smithy.api#documentation": "

The unique identifier for the shard iterator. This value is used in the GetRecords operation to retrieve data records from the specified shard. Each shard iterator expires 5 minutes after it is returned to the requester.

" + "smithy.api#documentation": "

The unique identifier for the shard iterator. This value is used in the GetRecords operation to retrieve data records from the specified shard. Each shard iterator expires 15 minutes after it is returned to the requester.

" } } }, @@ -224,7 +224,7 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of shard objects to return in a single GetStream request. Default value is 100. The minimum value is 1 and the maximum value is 1000.

", + "smithy.api#documentation": "

The maximum number of shard objects to return in a single GetStream request. Default value is 100. The minimum value is 1 and the maximum value is 100.

", "smithy.api#range": { "min": 1, "max": 100 @@ -1074,7 +1074,7 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of streams to return in a single ListStreams request. Default value is 100. The minimum value is 1 and the maximum value is 1000.

", + "smithy.api#documentation": "

The maximum number of streams to return in a single ListStreams request. Default value is 100. The minimum value is 1 and the maximum value is 100.

", "smithy.api#range": { "min": 1, "max": 100 diff --git a/codegen/sdk/aws-models/kms.json b/codegen/sdk/aws-models/kms.json index 6bae8a5b7eb..3d799c399b0 100644 --- a/codegen/sdk/aws-models/kms.json +++ b/codegen/sdk/aws-models/kms.json @@ -639,14 +639,14 @@ "AliasName": { "target": "com.amazonaws.kms#AliasNameType", "traits": { - "smithy.api#documentation": "

Specifies the alias name. This value must begin with alias/ followed by a\n name, such as alias/ExampleAlias.

\n \n

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

\n \n

The AliasName value must be string of 1-256 characters. It can contain only\n alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name\n cannot begin with alias/aws/. The alias/aws/ prefix is reserved for\n Amazon Web Services managed\n keys.

", + "smithy.api#documentation": "

Specifies the alias name. This value must begin with alias/ followed by a\n name, such as alias/ExampleAlias.

\n \n

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

\n \n

The AliasName value must be string of 1-256 characters. It can contain only\n alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name\n cannot begin with alias/aws/. The alias/aws/ prefix is reserved for\n Amazon Web Services managed\n keys.

", "smithy.api#required": {} } }, "TargetKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Associates the alias with the specified customer managed key. The KMS key must\n be in the same Amazon Web Services Region.

\n

A valid key ID is required. If you supply a null or empty string value, this operation\n returns an error.

\n

For help finding the key ID and ARN, see Find the key ID and key ARN in\n the \n Key Management Service Developer Guide\n .

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
\n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", + "smithy.api#documentation": "

Associates the alias with the specified customer managed key. The KMS key must\n be in the same Amazon Web Services Region.

\n

A valid key ID is required. If you supply a null or empty string value, this operation\n returns an error.

\n

For help finding the key ID and ARN, see Find the key ID and key ARN in\n the \n Key Management Service Developer Guide\n .

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
\n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -1006,7 +1006,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a unique customer managed KMS key in your Amazon Web Services account and Region.\n You can use a KMS key in cryptographic operations, such as encryption and signing. Some Amazon Web Services\n services let you use KMS keys that you create and manage to protect your service\n resources.

\n

A KMS key is a logical representation of a cryptographic key. In addition to the key\n material used in cryptographic operations, a KMS key includes metadata, such as the key ID,\n key policy, creation date, description, and key state.

\n

Use the parameters of CreateKey to specify the type of KMS key, the source of\n its key material, its key policy, description, tags, and other properties.

\n \n

KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n \n

To create different types of KMS keys, use the following guidance:

\n
\n
Symmetric encryption KMS key
\n
\n

By default, CreateKey creates a symmetric encryption KMS key with key\n material that KMS generates. This is the basic and most widely used type of KMS key, and\n provides the best performance.

\n

To create a symmetric encryption KMS key, you don't need to specify any parameters.\n The default value for KeySpec, SYMMETRIC_DEFAULT, the default\n value for KeyUsage, ENCRYPT_DECRYPT, and the default value for\n Origin, AWS_KMS, create a symmetric encryption KMS key with\n KMS key material.

\n

If you need a key for basic encryption and decryption or you are creating a KMS key\n to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key.\n The key material in a symmetric encryption key never leaves KMS unencrypted. You can\n use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but\n they are typically used to generate data keys and data keys pairs. For details, see\n GenerateDataKey and GenerateDataKeyPair.

\n

\n
\n
Asymmetric KMS keys
\n
\n

To create an asymmetric KMS key, use the KeySpec parameter to specify\n the type of key material in the KMS key. Then, use the KeyUsage parameter\n to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.\n You can't change these properties after the KMS key is created.

\n

Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC) key pair, ML-DSA\n key pair or an SM2 key pair (China Regions only). The private key in an asymmetric KMS\n key never leaves KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used\n outside of KMS. Each KMS key can have only one key usage. KMS keys with RSA key pairs\n can be used to encrypt and decrypt data or sign and verify messages (but not both). KMS\n keys with NIST-recommended ECC key pairs can be used to sign and verify messages or\n derive shared secrets (but not both). KMS keys with ECC_SECG_P256K1 can be\n used only to sign and verify messages. KMS keys with ML-DSA key pairs can be used to\n sign and verify messages. KMS keys with SM2 key pairs (China Regions only) can be used\n to either encrypt and decrypt data, sign and verify messages, or derive shared secrets\n (you must choose one key usage type). For information about asymmetric KMS keys, see\n Asymmetric\n KMS keys in the Key Management Service Developer Guide.

\n

\n
\n
HMAC KMS key
\n
\n

To create an HMAC KMS key, set the KeySpec parameter to a key spec\n value for HMAC KMS keys. Then set the KeyUsage parameter to\n GENERATE_VERIFY_MAC. You must set the key usage even though\n GENERATE_VERIFY_MAC is the only valid key usage value for HMAC KMS keys.\n You can't change these properties after the KMS key is created.

\n

HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use\n HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes.

\n

\n
\n
Multi-Region primary keys
\n
Imported key material
\n
\n

To create a multi-Region primary key in the local Amazon Web Services Region,\n use the MultiRegion parameter with a value of True. To create\n a multi-Region replica key, that is, a KMS key with the same key ID\n and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its\n primary key to a replica key, use the UpdatePrimaryRegion\n operation.

\n

You can create multi-Region KMS keys for all supported KMS key types: symmetric\n encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric\n signing KMS keys. You can also create multi-Region keys with imported key material.\n However, you can't create multi-Region keys in a custom key store.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

\n
\n
\n

To import your own key material into a KMS key, begin by creating a KMS key with no\n key material. To do this, use the Origin parameter of\n CreateKey with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token. Use\n the wrapping public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For\n step-by-step instructions, see Importing Key Material in the \n Key Management Service Developer Guide\n .

\n

You can import key material into KMS keys of all supported KMS key types: symmetric\n encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric\n signing KMS keys. You can also create multi-Region keys with imported key material.\n However, you can't import key material into a KMS key in a custom key store.

\n

To create a multi-Region primary key with imported key material, use the\n Origin parameter of CreateKey with a value of\n EXTERNAL and the MultiRegion parameter with a value of\n True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For instructions, see Importing key material step\n 1. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

\n
\n
Custom key store
\n
\n

A custom key store lets you protect your Amazon Web Services resources using keys in a backing key\n store that you own and manage. When you request a cryptographic operation with a KMS key\n in a custom key store, the operation is performed in the backing key store using its\n cryptographic keys.

\n

KMS supports CloudHSM key stores backed by an CloudHSM cluster and external key stores backed by an\n external key manager outside of Amazon Web Services. When you create a KMS key in an CloudHSM key store,\n KMS generates an encryption key in the CloudHSM cluster and associates it with the KMS\n key. When you create a KMS key in an external key store, you specify an existing\n encryption key in the external key manager.

\n \n

Some external key managers provide a simpler method for creating a KMS key in an\n external key store. For details, see your external key manager documentation.

\n \n

Before you create a KMS key in a custom key store, the ConnectionState\n of the key store must be CONNECTED. To connect the custom key store, use\n the ConnectCustomKeyStore operation. To find the\n ConnectionState, use the DescribeCustomKeyStores\n operation.

\n

To create a KMS key in a custom key store, use the CustomKeyStoreId.\n Use the default KeySpec value, SYMMETRIC_DEFAULT, and the\n default KeyUsage value, ENCRYPT_DECRYPT to create a symmetric\n encryption key. No other key type is supported in a custom key store.

\n

To create a KMS key in an CloudHSM key store, use the\n Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM\n cluster that is associated with the custom key store must have at least two active HSMs\n in different Availability Zones in the Amazon Web Services Region.

\n

To create a KMS key in an external key store, use the\n Origin parameter with a value of EXTERNAL_KEY_STORE and an\n XksKeyId parameter that identifies an existing external key.

\n \n

Some external key managers provide a simpler method for creating a KMS key in an\n external key store. For details, see your external key manager documentation.

\n \n
\n
\n

\n Cross-account use: No. You cannot use this operation to\n create a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:CreateKey (IAM policy). To use the\n Tags parameter, kms:TagResource (IAM policy). For examples and information about related\n permissions, see Allow a user\n to create KMS keys in the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

" + "smithy.api#documentation": "

Creates a unique customer managed KMS key in your Amazon Web Services account and Region.\n You can use a KMS key in cryptographic operations, such as encryption and signing. Some Amazon Web Services\n services let you use KMS keys that you create and manage to protect your service\n resources.

\n

A KMS key is a logical representation of a cryptographic key. In addition to the key\n material used in cryptographic operations, a KMS key includes metadata, such as the key ID,\n key policy, creation date, description, and key state.

\n

Use the parameters of CreateKey to specify the type of KMS key, the source of\n its key material, its key policy, description, tags, and other properties.

\n \n

KMS has replaced the term customer master key (CMK) with Key Management Service key \n and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n \n

To create different types of KMS keys, use the following guidance:

\n
\n
Symmetric encryption KMS key
\n
\n

By default, CreateKey creates a symmetric encryption KMS key with key\n material that KMS generates. This is the basic and most widely used type of KMS key, and\n provides the best performance.

\n

To create a symmetric encryption KMS key, you don't need to specify any parameters.\n The default value for KeySpec, SYMMETRIC_DEFAULT, the default\n value for KeyUsage, ENCRYPT_DECRYPT, and the default value for\n Origin, AWS_KMS, create a symmetric encryption KMS key with\n KMS key material.

\n

If you need a key for basic encryption and decryption or you are creating a KMS key\n to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key.\n The key material in a symmetric encryption key never leaves KMS unencrypted. You can\n use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but\n they are typically used to generate data keys and data keys pairs. For details, see\n GenerateDataKey and GenerateDataKeyPair.

\n

\n
\n
Asymmetric KMS keys
\n
\n

To create an asymmetric KMS key, use the KeySpec parameter to specify\n the type of key material in the KMS key. Then, use the KeyUsage parameter\n to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.\n You can't change these properties after the KMS key is created.

\n

Asymmetric KMS keys contain an RSA key pair, Elliptic Curve (ECC) key pair, ML-DSA\n key pair or an SM2 key pair (China Regions only). The private key in an asymmetric KMS\n key never leaves KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used\n outside of KMS. Each KMS key can have only one key usage. KMS keys with RSA key pairs\n can be used to encrypt and decrypt data or sign and verify messages (but not both). KMS\n keys with NIST-recommended ECC key pairs can be used to sign and verify messages or\n derive shared secrets (but not both). KMS keys with ECC_SECG_P256K1 can be\n used only to sign and verify messages. KMS keys with ML-DSA key pairs can be used to\n sign and verify messages. KMS keys with SM2 key pairs (China Regions only) can be used\n to either encrypt and decrypt data, sign and verify messages, or derive shared secrets\n (you must choose one key usage type). For information about asymmetric KMS keys, see\n Asymmetric\n KMS keys in the Key Management Service Developer Guide.

\n

\n
\n
HMAC KMS key
\n
\n

To create an HMAC KMS key, set the KeySpec parameter to a key spec\n value for HMAC KMS keys. Then set the KeyUsage parameter to\n GENERATE_VERIFY_MAC. You must set the key usage even though\n GENERATE_VERIFY_MAC is the only valid key usage value for HMAC KMS keys.\n You can't change these properties after the KMS key is created.

\n

HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use\n HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes.

\n

\n
\n
Multi-Region primary keys
\n
Imported key material
\n
\n

To create a multi-Region primary key in the local Amazon Web Services Region,\n use the MultiRegion parameter with a value of True. To create\n a multi-Region replica key, that is, a KMS key with the same key ID\n and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its\n primary key to a replica key, use the UpdatePrimaryRegion\n operation.

\n

You can create multi-Region KMS keys for all supported KMS key types: symmetric\n encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric\n signing KMS keys. You can also create multi-Region keys with imported key material.\n However, you can't create multi-Region keys in a custom key store.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

\n
\n
\n

To import your own key material into a KMS key, begin by creating a KMS key with no\n key material. To do this, use the Origin parameter of\n CreateKey with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token. Use\n the wrapping public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For\n step-by-step instructions, see Importing Key Material in the \n Key Management Service Developer Guide\n .

\n

You can import key material into KMS keys of all supported KMS key types: symmetric\n encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric\n signing KMS keys. You can also create multi-Region keys with imported key material.\n However, you can't import key material into a KMS key in a custom key store.

\n

To create a multi-Region primary key with imported key material, use the\n Origin parameter of CreateKey with a value of\n EXTERNAL and the MultiRegion parameter with a value of\n True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For instructions, see Importing key material step\n 1. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

\n
\n
Custom key store
\n
\n

A custom key store lets you protect your Amazon Web Services resources using keys in a backing key\n store that you own and manage. When you request a cryptographic operation with a KMS key\n in a custom key store, the operation is performed in the backing key store using its\n cryptographic keys.

\n

KMS supports CloudHSM key stores backed by an CloudHSM cluster and external key stores backed by an\n external key manager outside of Amazon Web Services. When you create a KMS key in an CloudHSM key store,\n KMS generates an encryption key in the CloudHSM cluster and associates it with the KMS\n key. When you create a KMS key in an external key store, you specify an existing\n encryption key in the external key manager.

\n \n

Some external key managers provide a simpler method for creating a KMS key in an\n external key store. For details, see your external key manager documentation.

\n \n

Before you create a KMS key in a custom key store, the ConnectionState\n of the key store must be CONNECTED. To connect the custom key store, use\n the ConnectCustomKeyStore operation. To find the\n ConnectionState, use the DescribeCustomKeyStores\n operation.

\n

To create a KMS key in a custom key store, use the CustomKeyStoreId.\n Use the default KeySpec value, SYMMETRIC_DEFAULT, and the\n default KeyUsage value, ENCRYPT_DECRYPT to create a symmetric\n encryption key. No other key type is supported in a custom key store.

\n

To create a KMS key in an CloudHSM key store, use the\n Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM\n cluster that is associated with the custom key store must have at least two active HSMs\n in different Availability Zones in the Amazon Web Services Region.

\n

To create a KMS key in an external key store, use the\n Origin parameter with a value of EXTERNAL_KEY_STORE and an\n XksKeyId parameter that identifies an existing external key.

\n \n

Some external key managers provide a simpler method for creating a KMS key in an\n external key store. For details, see your external key manager documentation.

\n \n
\n
\n

\n Cross-account use: No. You cannot use this operation to\n create a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:CreateKey (IAM policy). To use the\n Tags parameter, kms:TagResource (IAM policy). For examples and information about related\n permissions, see Allow a user\n to create KMS keys in the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

" } }, "com.amazonaws.kms#CreateKeyRequest": { @@ -2070,7 +2070,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides detailed information about a KMS key. You can run DescribeKey on a\n customer managed\n key or an Amazon Web Services managed key.

\n

This detailed information includes the key ARN, creation date (and deletion date, if\n applicable), the key state, and the origin and expiration date (if any) of the key material.\n It includes fields, like KeySpec, that help you distinguish different types of\n KMS keys. It also displays the key usage (encryption, signing, or generating and verifying\n MACs) and the algorithms that the KMS key supports.

\n

For multi-Region keys, DescribeKey displays the primary key and all\n related replica keys. For KMS keys in CloudHSM key stores, it includes information\n about the key store, such as the key store ID and the CloudHSM cluster ID. For KMS keys in external key stores,\n it includes the custom key store ID and the ID of the external key.

\n

\n DescribeKey does not return the following information:

\n
    \n
  • \n

    Aliases associated with the KMS key. To get this information, use ListAliases.

    \n
    • \n
  • \n

    Whether automatic key rotation is enabled on the KMS key. To get this information, use\n GetKeyRotationStatus. Also, some key states prevent a KMS key from\n being automatically rotated. For details, see How key rotation\n works in the Key Management Service Developer Guide.

    \n
    • \n
  • \n

    Tags on the KMS key. To get this information, use ListResourceTags.

    \n
    • \n
  • \n

    Key policies and grants on the KMS key. To get this information, use GetKeyPolicy and ListGrants.

    \n
    • \n
\n

In general, DescribeKey is a non-mutating operation. It returns data about\n KMS keys, but doesn't change them. However, Amazon Web Services services use DescribeKey to\n create Amazon Web Services\n managed keys from a predefined Amazon Web Services alias with no key\n ID.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:DescribeKey (key policy)

\n

\n Related operations:\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

", + "smithy.api#documentation": "

Provides detailed information about a KMS key. You can run DescribeKey on a\n customer managed\n key or an Amazon Web Services managed key.

\n

This detailed information includes the key ARN, creation date (and deletion date, if\n applicable), the key state, and the origin and expiration date (if any) of the key material.\n It includes fields, like KeySpec, that help you distinguish different types of\n KMS keys. It also displays the key usage (encryption, signing, or generating and verifying\n MACs) and the algorithms that the KMS key supports.

\n

For multi-Region keys, DescribeKey displays the primary key and all\n related replica keys. For KMS keys in CloudHSM key stores, it includes information\n about the key store, such as the key store ID and the CloudHSM cluster ID. For KMS keys in external key stores,\n it includes the custom key store ID and the ID of the external key.

\n

\n DescribeKey does not return the following information:

\n
    \n
  • \n

    Aliases associated with the KMS key. To get this information, use ListAliases.

    \n
    • \n
  • \n

    Whether automatic key rotation is enabled on the KMS key. To get this information, use\n GetKeyRotationStatus. Also, some key states prevent a KMS key from\n being automatically rotated. For details, see How key rotation\n works in the Key Management Service Developer Guide.

    \n
    • \n
  • \n

    Tags on the KMS key. To get this information, use ListResourceTags.

    \n
    • \n
  • \n

    Key policies and grants on the KMS key. To get this information, use GetKeyPolicy and ListGrants.

    \n
    • \n
\n

In general, DescribeKey is a non-mutating operation. It returns data about\n KMS keys, but doesn't change them. However, Amazon Web Services services use DescribeKey to\n create Amazon Web Services\n managed keys from a predefined Amazon Web Services alias with no key\n ID.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:DescribeKey (key policy)

\n

\n Related operations:\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

", "smithy.api#examples": [ { "title": "To get details about a KMS key in an AWS CloudHSM key store", @@ -2247,7 +2247,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Describes the specified KMS key.

\n

If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS associates\n the alias with an Amazon Web Services managed key and returns its\n KeyId and Arn in the response.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
\n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", + "smithy.api#documentation": "

Describes the specified KMS key.

\n

If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS associates\n the alias with an Amazon Web Services managed key and returns its\n KeyId and Arn in the response.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
\n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -2370,7 +2370,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables automatic rotation of the key material of the specified symmetric encryption KMS\n key.

\n

Automatic key rotation is supported only on symmetric encryption KMS keys.\n You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

You can enable (EnableKeyRotation) and disable automatic rotation of the\n key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not\n configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS\n keys varies.

\n \n

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three\n years to every year. For details, see EnableKeyRotation.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:DisableKeyRotation (key policy)

\n

\n Related operations:\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

", + "smithy.api#documentation": "

Disables automatic rotation of the key material of the specified symmetric encryption KMS\n key.

\n

Automatic key rotation is supported only on symmetric encryption KMS keys.\n You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

You can enable (EnableKeyRotation) and disable automatic rotation of the\n key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not\n configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS\n keys varies.

\n \n

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three\n years to every year. For details, see EnableKeyRotation.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:DisableKeyRotation (key policy)

\n

\n Related operations:\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

", "smithy.api#examples": [ { "title": "To disable automatic rotation of key material", @@ -2574,7 +2574,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables automatic rotation of the key material of the specified symmetric encryption KMS\n key.

\n

By default, when you enable automatic rotation of a customer managed KMS key, KMS\n rotates the key material of the KMS key one year (approximately 365 days) from the enable date\n and every year thereafter. You can use the optional RotationPeriodInDays\n parameter to specify a custom rotation period when you enable key rotation, or you can use\n RotationPeriodInDays to modify the rotation period of a key that you previously\n enabled automatic key rotation on.

\n

You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use\n the DisableKeyRotation operation. You can use the GetKeyRotationStatus operation to identify any in progress rotations. You can\n use the ListKeyRotations operation to view the details of completed\n rotations.

\n

Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

You cannot enable or disable automatic rotation of Amazon Web Services managed KMS keys. KMS\n always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS\n keys is managed by the Amazon Web Services service that owns the key.

\n \n

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three\n years (approximately 1,095 days) to every year (approximately 365 days).

\n

New Amazon Web Services managed keys are automatically rotated one year after they are created, and\n approximately every year thereafter.

\n

Existing Amazon Web Services managed keys are automatically rotated one year after their most recent\n rotation, and every year thereafter.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:EnableKeyRotation (key policy)

\n

\n Related operations:\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

", + "smithy.api#documentation": "

Enables automatic rotation of the key material of the specified symmetric encryption KMS\n key.

\n

By default, when you enable automatic rotation of a customer managed KMS key, KMS\n rotates the key material of the KMS key one year (approximately 365 days) from the enable date\n and every year thereafter. You can use the optional RotationPeriodInDays\n parameter to specify a custom rotation period when you enable key rotation, or you can use\n RotationPeriodInDays to modify the rotation period of a key that you previously\n enabled automatic key rotation on.

\n

You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use\n the DisableKeyRotation operation. You can use the GetKeyRotationStatus operation to identify any in progress rotations. You can\n use the ListKeyRotations operation to view the details of completed\n rotations.

\n

Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

You cannot enable or disable automatic rotation of Amazon Web Services managed KMS keys. KMS\n always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS\n keys is managed by the Amazon Web Services service that owns the key.

\n \n

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three\n years (approximately 1,095 days) to every year (approximately 365 days).

\n

New Amazon Web Services managed keys are automatically rotated one year after they are created, and\n approximately every year thereafter.

\n

Existing Amazon Web Services managed keys are automatically rotated one year after their most recent\n rotation, and every year thereafter.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:EnableKeyRotation (key policy)

\n

\n Related operations:\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

", "smithy.api#examples": [ { "title": "To enable automatic rotation of key material", @@ -3727,7 +3727,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides detailed information about the rotation status for a KMS key, including whether\n automatic\n rotation of the key material is enabled for the specified KMS key, the rotation\n period, and the next scheduled rotation date.

\n

Automatic key rotation is supported only on symmetric encryption KMS keys.\n You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key\n material rotation of Amazon Web Services managed KMS keys is not\n configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The\n key rotation status for Amazon Web Services managed KMS keys is always true.

\n

You can perform on-demand (RotateKeyOnDemand) rotation of the key\n material in customer managed KMS keys, regardless of whether or not automatic key rotation is\n enabled. You can use GetKeyRotationStatus to identify the date and time that an in progress\n on-demand rotation was initiated. You can use ListKeyRotations to view the\n details of completed rotations.

\n \n

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three\n years to every year. For details, see EnableKeyRotation.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n
    \n
  • \n

    Disabled: The key rotation status does not change when you disable a KMS key. However,\n while the KMS key is disabled, KMS does not rotate the key material. When you re-enable\n the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been\n rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been\n less than a year since the key material in the re-enabled KMS key was rotated, the KMS key\n resumes its prior rotation schedule.

    \n
    • \n
  • \n

    Pending deletion: While a KMS key is pending deletion, its key rotation status is\n false and KMS does not rotate the key material. If you cancel the\n deletion, the original key rotation status returns to true.

    \n
    • \n
\n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:GetKeyRotationStatus (key policy)

\n

\n Related operations:\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

" + "smithy.api#documentation": "

Provides detailed information about the rotation status for a KMS key, including whether\n automatic\n rotation of the key material is enabled for the specified KMS key, the rotation\n period, and the next scheduled rotation date.

\n

Automatic key rotation is supported only on symmetric encryption KMS keys.\n You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key\n material rotation of Amazon Web Services managed KMS keys is not\n configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The\n key rotation status for Amazon Web Services managed KMS keys is always true.

\n

You can perform on-demand (RotateKeyOnDemand) rotation of the key\n material in customer managed KMS keys, regardless of whether or not automatic key rotation is\n enabled. You can use GetKeyRotationStatus to identify the date and time that an in progress\n on-demand rotation was initiated. You can use ListKeyRotations to view the\n details of completed rotations.

\n \n

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three\n years to every year. For details, see EnableKeyRotation.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n
    \n
  • \n

    Disabled: The key rotation status does not change when you disable a KMS key. However,\n while the KMS key is disabled, KMS does not rotate the key material. When you re-enable\n the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been\n rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been\n less than a year since the key material in the re-enabled KMS key was rotated, the KMS key\n resumes its prior rotation schedule.

    \n
    • \n
  • \n

    Pending deletion: While a KMS key is pending deletion, its key rotation status is\n false and KMS does not rotate the key material. If you cancel the\n deletion, the original key rotation status returns to true.

    \n
    • \n
\n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:GetKeyRotationStatus (key policy)

\n

\n Related operations:\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

" } }, "com.amazonaws.kms#GetKeyRotationStatusRequest": { @@ -6880,7 +6880,7 @@ } ], "traits": { - "smithy.api#documentation": "

Immediately initiates rotation of the key material of the specified symmetric encryption\n KMS key.

\n

You can perform on-demand rotation of the key\n material in customer managed KMS keys, regardless of whether or not automatic key\n rotation is enabled. On-demand rotations do not change existing automatic rotation\n schedules. For example, consider a KMS key that has automatic key rotation enabled with a\n rotation period of 730 days. If the key is scheduled to automatically rotate on April 14,\n 2024, and you perform an on-demand rotation on April 10, 2024, the key will automatically\n rotate, as scheduled, on April 14, 2024 and every 730 days thereafter.

\n \n

You can perform on-demand key rotation a maximum of 10\n times per KMS key. You can use the KMS console to view the number of\n remaining on-demand rotations available for a KMS key.

\n \n

You can use GetKeyRotationStatus to identify any in progress on-demand\n rotations. You can use ListKeyRotations to identify the date that completed\n on-demand rotations were performed. You can monitor rotation of the key material for your KMS\n keys in CloudTrail and Amazon CloudWatch.

\n

On-demand key rotation is supported only on symmetric encryption KMS keys. You cannot\n perform on-demand rotation of asymmetric KMS keys, HMAC KMS keys, multi-Region KMS\n keys with imported key\n material, or KMS keys in a custom key store. When you initiate on-demand key\n rotation on a symmetric encryption KMS key with imported key material, you must have already\n imported new key material and that\n key material's state should be PENDING_ROTATION. Use the\n ListKeyRotations operation to check the state of all key materials associated\n with a KMS key. To perform on-demand rotation of a set of related multi-Region keys, invoke\n the on-demand rotation on the primary key.

\n

You cannot initiate on-demand rotation of Amazon Web Services managed KMS keys. KMS\n always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS\n keys is managed by the Amazon Web Services service that owns the key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:RotateKeyOnDemand (key policy)

\n

\n Related operations:\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

", + "smithy.api#documentation": "

Immediately initiates rotation of the key material of the specified symmetric encryption\n KMS key.

\n

You can perform on-demand rotation of the key\n material in customer managed KMS keys, regardless of whether or not automatic key\n rotation is enabled. On-demand rotations do not change existing automatic rotation\n schedules. For example, consider a KMS key that has automatic key rotation enabled with a\n rotation period of 730 days. If the key is scheduled to automatically rotate on April 14,\n 2024, and you perform an on-demand rotation on April 10, 2024, the key will automatically\n rotate, as scheduled, on April 14, 2024 and every 730 days thereafter.

\n \n

You can perform on-demand key rotation a maximum of 10\n times per KMS key. You can use the KMS console to view the number of\n remaining on-demand rotations available for a KMS key.

\n \n

You can use GetKeyRotationStatus to identify any in progress on-demand\n rotations. You can use ListKeyRotations to identify the date that completed\n on-demand rotations were performed. You can monitor rotation of the key material for your KMS\n keys in CloudTrail and Amazon CloudWatch.

\n

On-demand key rotation is supported only on symmetric encryption KMS keys. You cannot\n perform on-demand rotation of asymmetric KMS keys, HMAC KMS keys, multi-Region KMS\n keys with imported key\n material, or KMS keys in a custom key store. When you initiate on-demand key\n rotation on a symmetric encryption KMS key with imported key material, you must have already\n imported new key material and that\n key material's state should be PENDING_ROTATION. Use the\n ListKeyRotations operation to check the state of all key materials associated\n with a KMS key. To perform on-demand rotation of a set of related multi-Region keys, invoke\n the on-demand rotation on the primary key.

\n

You cannot initiate on-demand rotation of Amazon Web Services managed KMS keys. KMS\n always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS\n keys is managed by the Amazon Web Services service that owns the key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:RotateKeyOnDemand (key policy)

\n

\n Related operations:\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

", "smithy.api#examples": [ { "title": "To perform on-demand rotation of key material", @@ -7412,7 +7412,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or edits tags on a customer managed key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

\n \n

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.\n The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag\n value. To edit a tag, specify an existing tag key and a new tag value.

\n

You can use this operation to tag a customer managed key, but you cannot\n tag an Amazon Web Services\n managed key, an Amazon Web Services owned key, a custom key store,\n or an alias.

\n

You can also add tags to a KMS key while creating it (CreateKey) or\n replicating it (ReplicateKey).

\n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:TagResource (key policy)

\n

\n Related operations\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

", + "smithy.api#documentation": "

Adds or edits tags on a customer managed key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

\n \n

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.\n The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag\n value. To edit a tag, specify an existing tag key and a new tag value.

\n

You can use this operation to tag a customer managed key, but you cannot\n tag an Amazon Web Services\n managed key, an Amazon Web Services owned key, a custom key store,\n or an alias.

\n

You can also add tags to a KMS key while creating it (CreateKey) or\n replicating it (ReplicateKey).

\n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:TagResource (key policy)

\n

\n Related operations\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

", "smithy.api#examples": [ { "title": "To tag a KMS key", @@ -7637,7 +7637,7 @@ "name": "kms" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Key Management Service\n

Key Management Service (KMS) is an encryption and key management web service. This guide describes\n the KMS operations that you can call programmatically. For general information about KMS,\n see the \n Key Management Service Developer Guide\n .

\n \n

KMS has replaced the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming\n languages and platforms (Java, Rust, Python, Ruby, .Net, macOS, Android, etc.). The SDKs\n provide a convenient way to create programmatic access to KMS and other Amazon Web Services services.\n For example, the SDKs take care of tasks such as signing requests (see below), managing\n errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs,\n including how to download and install them, see Tools\n for Amazon Web Services.

\n \n

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.

\n

If you need to use FIPS 140-2 validated cryptographic modules when communicating with\n Amazon Web Services, use one of the FIPS endpoints in your preferred Amazon Web Services Region. If you need communicate\n over IPv6, use the dual-stack endpoint in your preferred Amazon Web Services Region. For more information\n see Service\n endpoints in the Key Management Service topic of the Amazon Web Services General Reference and Dual-stack endpoint\n support in the KMS Developer Guide.

\n

All KMS API calls must be signed and be transmitted using Transport Layer Security\n (TLS). KMS recommends you always use the latest supported TLS version. Clients must also\n support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman\n (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7\n and later support these modes.

\n

\n Signing Requests\n

\n

Requests must be signed using an access key ID and a secret access key. We strongly\n recommend that you do not use your Amazon Web Services account root access key ID and secret access key for\n everyday work. You can use the access key ID and secret access key for an IAM user or you\n can use the Security Token Service (STS) to generate temporary security credentials and use those to sign\n requests.

\n

All KMS requests must be signed with Signature Version 4.

\n

\n Logging API Requests\n

\n

KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your\n Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the\n information collected by CloudTrail, you can determine what requests were made to KMS, who made\n the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it\n on and find your log files, see the CloudTrail User Guide.

\n

\n Additional Resources\n

\n

For more information about credentials and request signing, see the following:

\n \n

\n Commonly Used API Operations\n

\n

Of the API operations discussed in this guide, the following will prove the most useful\n for most applications. You will likely perform operations other than these, such as creating\n keys and assigning policies, by using the console.

\n ", + "smithy.api#documentation": "Key Management Service\n

Key Management Service (KMS) is an encryption and key management web service. This guide describes\n the KMS operations that you can call programmatically. For general information about KMS,\n see the \n Key Management Service Developer Guide\n .

\n \n

KMS has replaced the term customer master key (CMK) with Key Management Service key \n and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming\n languages and platforms (Java, Rust, Python, Ruby, .Net, macOS, Android, etc.). The SDKs\n provide a convenient way to create programmatic access to KMS and other Amazon Web Services services.\n For example, the SDKs take care of tasks such as signing requests (see below), managing\n errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs,\n including how to download and install them, see Tools\n for Amazon Web Services.

\n \n

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.

\n

If you need to use FIPS 140-2 validated cryptographic modules when communicating with\n Amazon Web Services, use one of the FIPS endpoints in your preferred Amazon Web Services Region. If you need communicate\n over IPv6, use the dual-stack endpoint in your preferred Amazon Web Services Region. For more information\n see Service\n endpoints in the Key Management Service topic of the Amazon Web Services General Reference and Dual-stack endpoint\n support in the KMS Developer Guide.

\n

All KMS API calls must be signed and be transmitted using Transport Layer Security\n (TLS). KMS recommends you always use the latest supported TLS version. Clients must also\n support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman\n (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7\n and later support these modes.

\n

\n Signing Requests\n

\n

Requests must be signed using an access key ID and a secret access key. We strongly\n recommend that you do not use your Amazon Web Services account root access key ID and secret access key for\n everyday work. You can use the access key ID and secret access key for an IAM user or you\n can use the Security Token Service (STS) to generate temporary security credentials and use those to sign\n requests.

\n

All KMS requests must be signed with Signature Version 4.

\n

\n Logging API Requests\n

\n

KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your\n Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the\n information collected by CloudTrail, you can determine what requests were made to KMS, who made\n the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it\n on and find your log files, see the CloudTrail User Guide.

\n

\n Additional Resources\n

\n

For more information about credentials and request signing, see the following:

\n \n

\n Commonly Used API Operations\n

\n

Of the API operations discussed in this guide, the following will prove the most useful\n for most applications. You will likely perform operations other than these, such as creating\n keys and assigning policies, by using the console.

\n ", "smithy.api#title": "AWS Key Management Service", "smithy.api#xmlNamespace": { "uri": "https://trent.amazonaws.com/doc/2014-11-01/" @@ -8935,7 +8935,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes tags from a customer managed key. To delete a tag,\n specify the tag key and the KMS key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

\n \n

When it succeeds, the UntagResource operation doesn't return any output.\n Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or\n return a response. To confirm that the operation worked, use the ListResourceTags operation.

\n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:UntagResource (key policy)

\n

\n Related operations\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

", + "smithy.api#documentation": "

Deletes tags from a customer managed key. To delete a tag,\n specify the tag key and the KMS key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

\n \n

When it succeeds, the UntagResource operation doesn't return any output.\n Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or\n return a response. To confirm that the operation worked, use the ListResourceTags operation.

\n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:UntagResource (key policy)

\n

\n Related operations\n

\n \n

\n Eventual consistency: The KMS API follows an eventual consistency model. \n For more information, see KMS eventual consistency.

", "smithy.api#examples": [ { "title": "To remove tags from a KMS key", @@ -9025,7 +9025,7 @@ "TargetKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the customer managed key to associate with the alias. You don't have permission to\n associate an alias with an Amazon Web Services managed key.

\n

The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new\n target KMS key must be the same type as the current target KMS key (both symmetric or both\n asymmetric or both HMAC) and they must have the same key usage.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
\n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

\n

To verify that the alias is mapped to the correct KMS key, use ListAliases.

", + "smithy.api#documentation": "

Identifies the customer managed key to associate with the alias. You don't have permission to\n associate an alias with an Amazon Web Services managed key.

\n

The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new\n target KMS key must be the same type as the current target KMS key (both symmetric or both\n asymmetric or both HMAC) and they must have the same key usage.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
\n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

\n

To verify that the alias is mapped to the correct KMS key, use ListAliases.

", "smithy.api#required": {} } } diff --git a/codegen/sdk/aws-models/lambda.json b/codegen/sdk/aws-models/lambda.json index d6f5ee8d09d..d36ea5fd5f2 100644 --- a/codegen/sdk/aws-models/lambda.json +++ b/codegen/sdk/aws-models/lambda.json @@ -1,241 +1,53 @@ { "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.lambda#AWSGirApiService": { "type": "service", "version": "2015-03-31", "operations": [ - { - "target": "com.amazonaws.lambda#AddLayerVersionPermission" - }, - { - "target": "com.amazonaws.lambda#AddPermission" - }, - { - "target": "com.amazonaws.lambda#CreateAlias" - }, - { - "target": "com.amazonaws.lambda#CreateCodeSigningConfig" - }, - { - "target": "com.amazonaws.lambda#CreateEventSourceMapping" - }, - { - "target": "com.amazonaws.lambda#CreateFunction" - }, - { - "target": "com.amazonaws.lambda#CreateFunctionUrlConfig" - }, - { - "target": "com.amazonaws.lambda#DeleteAlias" - }, - { - "target": "com.amazonaws.lambda#DeleteCodeSigningConfig" - }, - { - "target": "com.amazonaws.lambda#DeleteEventSourceMapping" - }, - { - "target": "com.amazonaws.lambda#DeleteFunction" - }, - { - "target": "com.amazonaws.lambda#DeleteFunctionCodeSigningConfig" - }, - { - "target": "com.amazonaws.lambda#DeleteFunctionConcurrency" - }, - { - "target": "com.amazonaws.lambda#DeleteFunctionEventInvokeConfig" - }, - { - "target": "com.amazonaws.lambda#DeleteFunctionUrlConfig" - }, - { - "target": "com.amazonaws.lambda#DeleteLayerVersion" - }, - { - "target": "com.amazonaws.lambda#DeleteProvisionedConcurrencyConfig" - }, { "target": "com.amazonaws.lambda#GetAccountSettings" }, - { - "target": "com.amazonaws.lambda#GetAlias" - }, - { - "target": "com.amazonaws.lambda#GetCodeSigningConfig" - }, - { - "target": "com.amazonaws.lambda#GetEventSourceMapping" - }, - { - "target": "com.amazonaws.lambda#GetFunction" - }, - { - "target": "com.amazonaws.lambda#GetFunctionCodeSigningConfig" - }, - { - "target": "com.amazonaws.lambda#GetFunctionConcurrency" - }, - { - "target": "com.amazonaws.lambda#GetFunctionConfiguration" - }, - { - "target": "com.amazonaws.lambda#GetFunctionEventInvokeConfig" - }, - { - "target": "com.amazonaws.lambda#GetFunctionRecursionConfig" - }, - { - "target": "com.amazonaws.lambda#GetFunctionUrlConfig" - }, - { - "target": "com.amazonaws.lambda#GetLayerVersion" - }, - { - "target": "com.amazonaws.lambda#GetLayerVersionByArn" - }, - { - "target": "com.amazonaws.lambda#GetLayerVersionPolicy" - }, - { - "target": "com.amazonaws.lambda#GetPolicy" - }, - { - "target": "com.amazonaws.lambda#GetProvisionedConcurrencyConfig" - }, - { - "target": "com.amazonaws.lambda#GetRuntimeManagementConfig" - }, - { - "target": "com.amazonaws.lambda#Invoke" - }, - { - "target": "com.amazonaws.lambda#InvokeAsync" - }, - { - "target": "com.amazonaws.lambda#InvokeWithResponseStream" - }, - { - "target": "com.amazonaws.lambda#ListAliases" - }, - { - "target": "com.amazonaws.lambda#ListCodeSigningConfigs" - }, - { - "target": "com.amazonaws.lambda#ListEventSourceMappings" - }, - { - "target": "com.amazonaws.lambda#ListFunctionEventInvokeConfigs" - }, - { - "target": "com.amazonaws.lambda#ListFunctions" - }, - { - "target": "com.amazonaws.lambda#ListFunctionsByCodeSigningConfig" - }, - { - "target": "com.amazonaws.lambda#ListFunctionUrlConfigs" - }, - { - "target": "com.amazonaws.lambda#ListLayers" - }, - { - "target": "com.amazonaws.lambda#ListLayerVersions" - }, - { - "target": "com.amazonaws.lambda#ListProvisionedConcurrencyConfigs" - }, { "target": "com.amazonaws.lambda#ListTags" }, { - "target": "com.amazonaws.lambda#ListVersionsByFunction" - }, - { - "target": "com.amazonaws.lambda#PublishLayerVersion" - }, - { - "target": "com.amazonaws.lambda#PublishVersion" - }, - { - "target": "com.amazonaws.lambda#PutFunctionCodeSigningConfig" - }, - { - "target": "com.amazonaws.lambda#PutFunctionConcurrency" - }, - { - "target": "com.amazonaws.lambda#PutFunctionEventInvokeConfig" - }, - { - "target": "com.amazonaws.lambda#PutFunctionRecursionConfig" - }, - { - "target": "com.amazonaws.lambda#PutProvisionedConcurrencyConfig" - }, - { - "target": "com.amazonaws.lambda#PutRuntimeManagementConfig" + "target": "com.amazonaws.lambda#TagResource" }, { - "target": "com.amazonaws.lambda#RemoveLayerVersionPermission" - }, + "target": "com.amazonaws.lambda#UntagResource" + } + ], + "resources": [ { - "target": "com.amazonaws.lambda#RemovePermission" + "target": "com.amazonaws.lambda#CodeSigningConfigResource" }, { - "target": "com.amazonaws.lambda#TagResource" + "target": "com.amazonaws.lambda#EventSourceMapping" }, { - "target": "com.amazonaws.lambda#UntagResource" + "target": "com.amazonaws.lambda#Function" }, { - "target": "com.amazonaws.lambda#UpdateAlias" + "target": "com.amazonaws.lambda#FunctionAlias" }, { - "target": "com.amazonaws.lambda#UpdateCodeSigningConfig" + "target": "com.amazonaws.lambda#FunctionVersionResource" }, { - "target": "com.amazonaws.lambda#UpdateEventSourceMapping" + "target": "com.amazonaws.lambda#LayerResource" }, { - "target": "com.amazonaws.lambda#UpdateFunctionCode" + "target": "com.amazonaws.lambda#LayerVersion" }, { - "target": "com.amazonaws.lambda#UpdateFunctionConfiguration" + "target": "com.amazonaws.lambda#Permission" }, { - "target": "com.amazonaws.lambda#UpdateFunctionEventInvokeConfig" + "target": "com.amazonaws.lambda#ProvisionedConcurrencyConfig" }, { - "target": "com.amazonaws.lambda#UpdateFunctionUrlConfig" + "target": "com.amazonaws.lambda#ResourcePolicy" } ], "traits": { @@ -246,11 +58,109 @@ "cloudTrailEventSource": "lambda.amazonaws.com", "endpointPrefix": "lambda" }, + "aws.api#tagEnabled": { + "disableDefaultOperations": true + }, "aws.auth#sigv4": { "name": "lambda" }, + "aws.iam#defineConditionKeys": { + "lambda:VpcIds": { + "type": "String", + "documentation": "Filters access by the ID of the VPC configured for the AWS Lambda function", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:SubnetIds": { + "type": "ArrayOfString", + "documentation": "Filters access by the ID of subnets configured for the AWS Lambda function", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:Layer": { + "type": "ArrayOfString", + "documentation": "Filters access by the ARN of a version of an AWS Lambda layer", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:EventSourceToken": { + "type": "String", + "documentation": "Filters access by the ID from a non-AWS event source configured for the AWS Lambda function", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:FunctionUrlAuthType": { + "type": "String", + "documentation": "Filters access by authorization type specified in request. Available during CreateFunctionUrlConfig, UpdateFunctionUrlConfig, DeleteFunctionUrlConfig, GetFunctionUrlConfig, ListFunctionUrlConfig, AddPermission and RemovePermission operations", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "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", + "required": false + }, + "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", + "required": false + }, + "lambda:CodeSigningConfigArn": { + "type": "ARN", + "documentation": "Filters access by the ARN of an AWS Lambda code signing config", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:FunctionArn": { + "type": "ARN", + "documentation": "Filters access by the ARN of an AWS Lambda function", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "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", + "required": false + }, + "lambda:SourceFunctionArn": { + "type": "ARN", + "documentation": "Filters access by the ARN of the AWS Lambda function from which the request originated", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:SecurityGroupIds": { + "type": "ArrayOfString", + "documentation": "Filters access by the ID of security groups configured for the AWS Lambda function", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + }, + "lambda:Principal": { + "type": "String", + "documentation": "Filters access by restricting the AWS service or account that can invoke a function", + "relativeDocumentation": "lambda-api-permissions-ref.html", + "required": false + } + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Lambda\n

\n Overview\n

\n

Lambda is a compute service that lets you run code without provisioning or managing servers.\n Lambda runs your code on a high-availability compute infrastructure and performs all of the\n administration of the compute resources, including server and operating system maintenance, capacity provisioning\n and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any\n type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.

\n

The Lambda API Reference provides information about\n each of the API methods, including details about the parameters in each API request and\n response.

\n

\n

You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command\n line tools to access the API. For installation instructions, see Tools for\n Amazon Web Services.

\n

For a list of Region-specific endpoints that Lambda supports, \n see Lambda\n endpoints and quotas in the Amazon Web Services General Reference..

\n

When making the API calls, you will need to\n authenticate your request by providing a signature. Lambda supports signature version 4. For more information,\n see Signature Version 4 signing process in the\n Amazon Web Services General Reference..

\n

\n CA certificates\n

\n

Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers\n can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your\n computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate\n environment and do not manage your own computer, you might need to ask an administrator to assist with the\n update process. The following list shows minimum operating system and Java versions:

\n
    \n
  • \n

    Microsoft Windows versions that have updates from January 2005 or later installed contain at least one\n of the required CAs in their trust list.

    \n
    • \n
  • \n

    Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and\n later versions contain at least one of the required CAs in their trust list.

    \n
    • \n
  • \n

    Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the\n required CAs in their default trusted CA list.

    \n
    • \n
  • \n

    Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December\n 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list.

    \n
    • \n
\n

When accessing the Lambda management console or Lambda API endpoints, whether through browsers or\n programmatically, you will need to ensure your client machines support any of the following CAs:

\n
    \n
  • \n

    Amazon Root CA 1

    \n
    • \n
  • \n

    Starfield Services Root Certificate Authority - G2

    \n
    • \n
  • \n

    Starfield Class 2 Certification Authority

    \n
    • \n
\n

Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer\n up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs.\n

", + "smithy.api#documentation": "Lambda

Overview

Lambda is a compute service that lets you run code without provisioning or managing servers. Lambda runs your code on a high-availability compute infrastructure and performs all of the administration of the compute resources, including server and operating system maintenance, capacity provisioning and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.

The Lambda API Reference provides information about each of the API methods, including details about the parameters in each API request and response.

You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools to access the API. For installation instructions, see Tools for Amazon Web Services.

For a list of Region-specific endpoints that Lambda supports, see Lambda endpoints and quotas in the Amazon Web Services General Reference..

When making the API calls, you will need to authenticate your request by providing a signature. Lambda supports signature version 4. For more information, see Signature Version 4 signing process in the Amazon Web Services General Reference..

CA certificates

Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate environment and do not manage your own computer, you might need to ask an administrator to assist with the update process. The following list shows minimum operating system and Java versions:

  • Microsoft Windows versions that have updates from January 2005 or later installed contain at least one of the required CAs in their trust list.

  • Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and later versions contain at least one of the required CAs in their trust list.

  • Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the required CAs in their default trusted CA list.

  • Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list.

When accessing the Lambda management console or Lambda API endpoints, whether through browsers or programmatically, you will need to ensure your client machines support any of the following CAs:

  • Amazon Root CA 1

  • Starfield Services Root Certificate Authority - G2

  • Starfield Class 2 Certification Authority

Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "pageSize": "MaxItems" + }, + "smithy.api#suppress": [ + "ServiceTagging" + ], "smithy.api#title": "AWS Lambda", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1553,7 +1463,7 @@ "target": "com.amazonaws.lambda#Long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum size of a deployment package when it's uploaded directly to Lambda. Use Amazon S3 for larger\n files.

" + "smithy.api#documentation": "

The maximum size of a deployment package when it's uploaded directly to Lambda. Use Amazon S3 for larger files.

" } }, "ConcurrentExecutions": { @@ -1566,7 +1476,7 @@ "UnreservedConcurrentExecutions": { "target": "com.amazonaws.lambda#UnreservedConcurrentExecutions", "traits": { - "smithy.api#documentation": "

The maximum number of simultaneous function executions, minus the capacity that's reserved for individual\n functions with PutFunctionConcurrency.

" + "smithy.api#documentation": "

The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with PutFunctionConcurrency.

" } } }, @@ -1634,7 +1544,16 @@ } ], "traits": { - "smithy.api#documentation": "

Adds permissions to the resource-based policy of a version of an Lambda\n layer. Use this action to grant layer\n usage permission to other accounts. You can grant permission to a single account, all accounts in an organization,\n or all Amazon Web Services accounts.

\n

To revoke permission, call RemoveLayerVersionPermission with the statement ID that you\n specified when you added it.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to add permissions to the resource-based policy of a version of an AWS Lambda layer", + "relativeDocumentation": "API_AddLayerVersionPermission.html", + "resources": { + "required": { + "layerVersion": {} + } + } + }, + "smithy.api#documentation": "

Adds permissions to the resource-based policy of a version of an Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts.

To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.

", "smithy.api#examples": [ { "title": "To add permissions to a layer version", @@ -1696,25 +1615,26 @@ "Principal": { "target": "com.amazonaws.lambda#LayerPermissionAllowedPrincipal", "traits": { - "smithy.api#documentation": "

An account ID, or * to grant layer usage permission to all\n accounts in an organization, or all Amazon Web Services accounts (if organizationId is not specified).\n For the last case, make sure that you really do want all Amazon Web Services accounts to have usage permission to this layer.\n

", + "smithy.api#documentation": "

An account ID, or * to grant layer usage permission to all accounts in an organization, or all Amazon Web Services accounts (if organizationId is not specified). For the last case, make sure that you really do want all Amazon Web Services accounts to have usage permission to this layer.

", "smithy.api#required": {} } }, "OrganizationId": { "target": "com.amazonaws.lambda#OrganizationId", "traits": { - "smithy.api#documentation": "

With the principal set to *, grant permission to all accounts in the specified\n organization.

" + "smithy.api#documentation": "

With the principal set to *, grant permission to all accounts in the specified organization.

" } }, "RevisionId": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

", + "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.

", "smithy.api#httpQuery": "RevisionId" } } }, "traits": { + "aws.api#data": "permissions", "smithy.api#input": {} } }, @@ -1770,7 +1690,20 @@ } ], "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 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.

", + "aws.iam#conditionKeys": [ + "lambda:FunctionUrlAuthType", + "lambda:Principal" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to give an AWS service or another account permission to use an AWS Lambda function", + "relativeDocumentation": "API_AddPermission.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Grants a principal permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.

To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Services services, the principal is a domain-style identifier that 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 you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.

This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.

", "smithy.api#examples": [ { "title": "To grant Amazon S3 permission to invoke a function", @@ -1814,7 +1747,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1829,27 +1762,27 @@ "Action": { "target": "com.amazonaws.lambda#Action", "traits": { - "smithy.api#documentation": "

The action that the principal can use on the function. For example, lambda:InvokeFunction or\n lambda:GetFunction.

", + "smithy.api#documentation": "

The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.

", "smithy.api#required": {} } }, "Principal": { "target": "com.amazonaws.lambda#Principal", "traits": { - "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#documentation": "

The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.

", "smithy.api#required": {} } }, "SourceArn": { "target": "com.amazonaws.lambda#Arn", "traits": { - "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.

" + "smithy.api#documentation": "

For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

Note that Lambda configures the comparison using the StringLike operator.

" } }, "SourceAccount": { "target": "com.amazonaws.lambda#SourceOwner", "traits": { - "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.

" + "smithy.api#documentation": "

For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource. Use this together with SourceArn to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.

" } }, "EventSourceToken": { @@ -1868,23 +1801,24 @@ "RevisionId": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

" + "smithy.api#documentation": "

Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

" } }, "PrincipalOrgID": { "target": "com.amazonaws.lambda#PrincipalOrgID", "traits": { - "smithy.api#documentation": "

The identifier for your organization in Organizations. Use this to grant permissions to all the\n Amazon Web Services accounts under this organization.

" + "smithy.api#documentation": "

The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.

" } }, "FunctionUrlAuthType": { "target": "com.amazonaws.lambda#FunctionUrlAuthType", "traits": { - "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

" + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

" } } }, "traits": { + "aws.api#data": "permissions", "smithy.api#input": {} } }, @@ -1961,7 +1895,7 @@ "RoutingConfig": { "target": "com.amazonaws.lambda#AliasRoutingConfiguration", "traits": { - "smithy.api#documentation": "

The routing\n configuration of the alias.

" + "smithy.api#documentation": "

The routing configuration of the alias.

" } }, "RevisionId": { @@ -2028,7 +1962,7 @@ "SigningProfileVersionArns": { "target": "com.amazonaws.lambda#SigningProfileVersionArns", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user\n who can sign a code package.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package.

", "smithy.api#required": {} } } @@ -2043,7 +1977,7 @@ "ConsumerGroupId": { "target": "com.amazonaws.lambda#URI", "traits": { - "smithy.api#documentation": "

The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources.\n After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see\n Customizable consumer group ID.

" + "smithy.api#documentation": "

The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

" } }, "SchemaRegistryConfig": { @@ -2250,18 +2184,63 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.lambda#CodeSigningConfigResource": { + "type": "resource", + "identifiers": { + "CodeSigningConfigId": { + "target": "com.amazonaws.lambda#CodeSigningConfigId" + } + }, + "create": { + "target": "com.amazonaws.lambda#CreateCodeSigningConfig" + }, + "list": { + "target": "com.amazonaws.lambda#ListCodeSigningConfigs" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.lambda#DeleteCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#GetCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#ListFunctionsByCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#UpdateCodeSigningConfig" + } + ], + "traits": { + "aws.api#arn": { + "template": "code-signing-config:{CodeSigningConfigId}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "code signing config", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "Represents an AWS Lambda code signing config", + "smithy.api#suppress": [ + "IamResourceTrait" + ] + } + }, "com.amazonaws.lambda#CodeSigningPolicies": { "type": "structure", "members": { "UntrustedArtifactOnDeployment": { "target": "com.amazonaws.lambda#CodeSigningPolicy", "traits": { - "smithy.api#documentation": "

Code signing configuration policy for deployment validation failure. If you set the policy to\n Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the\n policy to Warn, Lambda allows the deployment and creates a CloudWatch log.

\n

Default value: Warn\n

" + "smithy.api#documentation": "

Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to Warn, Lambda allows the deployment and creates a CloudWatch log.

Default value: Warn

" } } }, "traits": { - "smithy.api#documentation": "

Code signing configuration policies specify the validation failure action for signature mismatch or\n expiry.

" + "smithy.api#documentation": "

Code signing configuration policies specify the validation failure action for signature mismatch or expiry.

" } }, "com.amazonaws.lambda#CodeSigningPolicy": { @@ -2311,7 +2290,7 @@ } }, "traits": { - "smithy.api#documentation": "

The code signature failed one or more of the validation checks for signature mismatch or expiry, and the code\n signing policy is set to ENFORCE. Lambda blocks the deployment.

", + "smithy.api#documentation": "

The code signature failed one or more of the validation checks for signature mismatch or expiry, and the code signing policy is set to ENFORCE. Lambda blocks the deployment.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2356,7 +2335,7 @@ "ReservedConcurrentExecutions": { "target": "com.amazonaws.lambda#ReservedConcurrentExecutions", "traits": { - "smithy.api#documentation": "

The number of concurrent executions that are reserved for this function. For more information, see Managing Lambda reserved\n concurrency.

" + "smithy.api#documentation": "

The number of concurrent executions that are reserved for this function. For more information, see Managing Lambda reserved concurrency.

" } } } @@ -2367,42 +2346,42 @@ "AllowCredentials": { "target": "com.amazonaws.lambda#AllowCredentials", "traits": { - "smithy.api#documentation": "

Whether to allow cookies or other credentials in requests to your function URL. The default is\n false.

" + "smithy.api#documentation": "

Whether to allow cookies or other credentials in requests to your function URL. The default is false.

" } }, "AllowHeaders": { "target": "com.amazonaws.lambda#HeadersList", "traits": { - "smithy.api#documentation": "

The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive,\n X-Custom-Header.

" + "smithy.api#documentation": "

The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header.

" } }, "AllowMethods": { "target": "com.amazonaws.lambda#AllowMethodsList", "traits": { - "smithy.api#documentation": "

The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE,\n or the wildcard character (*).

" + "smithy.api#documentation": "

The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*).

" } }, "AllowOrigins": { "target": "com.amazonaws.lambda#AllowOriginsList", "traits": { - "smithy.api#documentation": "

The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example:\n https://www.example.com, http://localhost:60905.

\n

Alternatively, you can grant access to all origins using the wildcard character (*).

" + "smithy.api#documentation": "

The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com, http://localhost:60905.

Alternatively, you can grant access to all origins using the wildcard character (*).

" } }, "ExposeHeaders": { "target": "com.amazonaws.lambda#HeadersList", "traits": { - "smithy.api#documentation": "

The HTTP headers in your function response that you want to expose to origins that call your function URL. For example:\n Date, Keep-Alive, X-Custom-Header.

" + "smithy.api#documentation": "

The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: Date, Keep-Alive, X-Custom-Header.

" } }, "MaxAge": { "target": "com.amazonaws.lambda#MaxAge", "traits": { - "smithy.api#documentation": "

The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By\n default, this is set to 0, which means that the browser doesn't cache results.

" + "smithy.api#documentation": "

The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn't cache results.

" } } }, "traits": { - "smithy.api#documentation": "

The cross-origin resource sharing\n (CORS) settings for your Lambda function URL. Use CORS to grant access to your function URL\n from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your\n function URL.

" + "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings for your Lambda function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL.

" } }, "com.amazonaws.lambda#CreateAlias": { @@ -2431,7 +2410,16 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an alias for a\n Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a\n different version.

\n

You can also map an alias to split invocation requests between two versions. Use the\n RoutingConfig parameter to specify a second version and the percentage of invocation requests that\n it receives.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to create an alias for a Lambda function version", + "relativeDocumentation": "API_CreateAlias.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.

You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

", "smithy.api#examples": [ { "title": "To create an alias for a Lambda function", @@ -2455,7 +2443,8 @@ "method": "POST", "uri": "/2015-03-31/functions/{FunctionName}/aliases", "code": 201 - } + }, + "smithy.api#idempotent": {} } }, "com.amazonaws.lambda#CreateAliasRequest": { @@ -2464,7 +2453,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2473,7 +2462,8 @@ "target": "com.amazonaws.lambda#Alias", "traits": { "smithy.api#documentation": "

The name of the alias.

", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Alias" } }, "FunctionVersion": { @@ -2492,7 +2482,7 @@ "RoutingConfig": { "target": "com.amazonaws.lambda#AliasRoutingConfiguration", "traits": { - "smithy.api#documentation": "

The routing\n configuration of the alias.

" + "smithy.api#documentation": "

The routing configuration of the alias.

" } } }, @@ -2517,7 +2507,18 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a code signing configuration. A code signing configuration defines a list of\n allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment\n validation checks fail).

", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], + "aws.iam#iamAction": { + "createsResources": [ + "code signing config" + ], + "documentation": "Grants permission to create an AWS Lambda code signing config", + "relativeDocumentation": "API_CreateCodeSigningConfig.html" + }, + "smithy.api#documentation": "

Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail).

", "smithy.api#http": { "method": "POST", "uri": "/2020-04-22/code-signing-configs", @@ -2599,7 +2600,19 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.

\n

For details about how to configure different event sources, see the following topics.

\n \n

The following error handling options are available only for DynamoDB and Kinesis event sources:

\n
    \n
  • \n

    \n BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

    \n
    • \n
  • \n

    \n MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

    \n
    • \n
  • \n

    \n MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

    \n
    • \n
  • \n

    \n ParallelizationFactor – Process multiple batches from each shard concurrently.

    \n
    • \n
\n

For stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka), the following option is also available:

\n
    \n
  • \n

    \n OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, or \n Amazon S3 bucket. For more information, see Adding a destination.

    \n
    • \n
\n

For information about which configuration parameters apply to each event source, see the following topics.

\n ", + "aws.iam#conditionKeys": [ + "aws:RequestTag/${TagKey}", + "lambda:FunctionArn", + "aws:TagKeys" + ], + "aws.iam#iamAction": { + "createsResources": [ + "eventSourceMapping" + ], + "documentation": "Grants permission to create a mapping between an event source and an AWS Lambda function", + "relativeDocumentation": "API_CreateEventSourceMapping.html" + }, + "smithy.api#documentation": "

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.

For details about how to configure different event sources, see the following topics.

The following error handling options are available only for DynamoDB and Kinesis event sources:

  • BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

  • MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

  • MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

  • ParallelizationFactor – Process multiple batches from each shard concurrently.

For stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka), the following option is also available:

  • OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, or Amazon S3 bucket. For more information, see Adding a destination.

For information about which configuration parameters apply to each event source, see the following topics.

", "smithy.api#examples": [ { "title": "To create a mapping between an event source and an AWS Lambda function", @@ -2633,38 +2646,38 @@ "EventSourceArn": { "target": "com.amazonaws.lambda#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

\n
    \n
  • \n

    \n Amazon Kinesis – The ARN of the data stream or a stream consumer.

    \n
    • \n
  • \n

    \n Amazon DynamoDB Streams – The ARN of the stream.

    \n
    • \n
  • \n

    \n Amazon Simple Queue Service – The ARN of the queue.

    \n
    • \n
  • \n

    \n Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

    \n
    • \n
  • \n

    \n Amazon MQ – The ARN of the broker.

    \n
    • \n
  • \n

    \n Amazon DocumentDB – The ARN of the DocumentDB change stream.

    \n
    • \n
" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

  • Amazon Kinesis – The ARN of the data stream or a stream consumer.

  • Amazon DynamoDB Streams – The ARN of the stream.

  • Amazon Simple Queue Service – The ARN of the queue.

  • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

  • Amazon MQ – The ARN of the broker.

  • Amazon DocumentDB – The ARN of the DocumentDB change stream.

" } }, "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – MyFunction.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – MyFunction.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN – 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

", "smithy.api#required": {} } }, "Enabled": { "target": "com.amazonaws.lambda#Enabled", "traits": { - "smithy.api#documentation": "

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

\n

Default: True

" + "smithy.api#documentation": "

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

Default: True

" } }, "BatchSize": { "target": "com.amazonaws.lambda#BatchSize", "traits": { - "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).

\n
    \n
  • \n

    \n Amazon Kinesis – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Amazon DynamoDB Streams – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

    \n
    • \n
  • \n

    \n Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Self-managed Apache Kafka – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n DocumentDB – Default 100. Max 10,000.

    \n
    • \n
" + "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

  • Amazon Kinesis – Default 100. Max 10,000.

  • Amazon DynamoDB Streams – Default 100. Max 10,000.

  • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

  • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

  • Self-managed Apache Kafka – Default 100. Max 10,000.

  • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

  • DocumentDB – Default 100. Max 10,000.

" } }, "FilterCriteria": { "target": "com.amazonaws.lambda#FilterCriteria", "traits": { - "smithy.api#documentation": "

An object that defines the filter criteria that\n determine whether Lambda should process an event. For more information, see Lambda event filtering.

" + "smithy.api#documentation": "

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

" } }, "MaximumBatchingWindowInSeconds": { "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", "traits": { - "smithy.api#documentation": "

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

\n

For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default\n batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.\n To restore the default batching window, you must create a new event source mapping.

\n

Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" + "smithy.api#documentation": "

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" } }, "ParallelizationFactor": { @@ -2676,13 +2689,13 @@ "StartingPosition": { "target": "com.amazonaws.lambda#EventSourcePosition", "traits": { - "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis and\n Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for\n Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

" + "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

" } }, "StartingPositionTimestamp": { "target": "com.amazonaws.lambda#Date", "traits": { - "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start\n reading. StartingPositionTimestamp cannot be in the future.

" + "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

" } }, "DestinationConfig": { @@ -2778,7 +2791,7 @@ "KMSKeyArn": { "target": "com.amazonaws.lambda#KMSKeyArn", "traits": { - "smithy.api#documentation": "

\n The ARN of the Key Management Service (KMS) customer managed key that Lambda\n uses to encrypt your function's filter criteria.\n By default, Lambda does not encrypt your filter criteria object. Specify this\n property to encrypt data using your own customer managed key.\n

" + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

" } }, "MetricsConfig": { @@ -2790,7 +2803,7 @@ "ProvisionedPollerConfig": { "target": "com.amazonaws.lambda#ProvisionedPollerConfig", "traits": { - "smithy.api#documentation": "

(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source.\n For more information, see provisioned mode.

" + "smithy.api#documentation": "

(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

" } } }, @@ -2836,7 +2849,31 @@ } ], "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 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.

", + "aws.iam#conditionKeys": [ + "lambda:VpcIds", + "lambda:SubnetIds", + "lambda:CodeSigningConfigArn", + "lambda:Layer", + "aws:RequestTag/${TagKey}", + "aws:TagKeys", + "lambda:SecurityGroupIds" + ], + "aws.iam#iamAction": { + "createsResources": [ + "function" + ], + "documentation": "Grants permission to create an AWS Lambda function", + "relativeDocumentation": "API_CreateFunction.html", + "requiredActions": [ + "iam:PassRole" + ], + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.

If the deployment package is a container image, then you set the package type to Image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.

If the deployment package is a .zip file archive, then you set the package type to Zip. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, then the default value is x86-64.

When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Lambda function states.

A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.

The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).

You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted publishers for this function.

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.

To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.

", "smithy.api#examples": [ { "title": "To create a function", @@ -2901,7 +2938,11 @@ "method": "POST", "uri": "/2015-03-31/functions", "code": 201 - } + }, + "smithy.api#idempotent": {}, + "smithy.api#suppress": [ + "TaggableResource" + ] } }, "com.amazonaws.lambda#CreateFunctionRequest": { @@ -2910,14 +2951,14 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#required": {} } }, "Runtime": { "target": "com.amazonaws.lambda#Runtime", "traits": { - "smithy.api#documentation": "

The identifier of the function's \n runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in\n an error if you're deploying a function using a container image.

\n

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing\n functions shortly after each runtime is deprecated. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

" + "smithy.api#documentation": "

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" } }, "Role": { @@ -2930,7 +2971,7 @@ "Handler": { "target": "com.amazonaws.lambda#Handler", "traits": { - "smithy.api#documentation": "

The name of the method within your code that Lambda calls to run your function. \nHandler is required if the deployment package is a .zip file archive. The format includes the\n file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information,\n see Lambda programming model.

" + "smithy.api#documentation": "

The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

" } }, "Code": { @@ -2949,13 +2990,13 @@ "Timeout": { "target": "com.amazonaws.lambda#Timeout", "traits": { - "smithy.api#documentation": "

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The\n maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

" + "smithy.api#documentation": "

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

" } }, "MemorySize": { "target": "com.amazonaws.lambda#MemorySize", "traits": { - "smithy.api#documentation": "

The amount of memory available to the function at runtime.\n Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

" + "smithy.api#documentation": "

The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

" } }, "Publish": { @@ -2968,7 +3009,7 @@ "VpcConfig": { "target": "com.amazonaws.lambda#VpcConfig", "traits": { - "smithy.api#documentation": "

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC.\n When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more\n information, see Configuring a Lambda function to access resources in a VPC.

" + "smithy.api#documentation": "

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

" } }, "PackageType": { @@ -2980,7 +3021,7 @@ "DeadLetterConfig": { "target": "com.amazonaws.lambda#DeadLetterConfig", "traits": { - "smithy.api#documentation": "

A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events\n when they fail processing. For more information, see Dead-letter queues.

" + "smithy.api#documentation": "

A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.

" } }, "Environment": { @@ -2992,25 +3033,25 @@ "KMSKeyArn": { "target": "com.amazonaws.lambda#KMSKeyArn", "traits": { - "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

\n
    \n
  • \n

    The function's environment variables.

    \n
    • \n
  • \n

    The function's Lambda SnapStart snapshots.

    \n
    • \n
  • \n

    When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see \nSpecifying a customer managed key for Lambda.

    \n
    • \n
  • \n

    The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

    \n
    • \n
\n

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

" + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

  • The function's environment variables.

  • The function's Lambda SnapStart snapshots.

  • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

  • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

" } }, "TracingConfig": { "target": "com.amazonaws.lambda#TracingConfig", "traits": { - "smithy.api#documentation": "

Set Mode to Active to sample and trace a subset of incoming requests with\nX-Ray.

" + "smithy.api#documentation": "

Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

" } }, "Tags": { "target": "com.amazonaws.lambda#Tags", "traits": { - "smithy.api#documentation": "

A list of tags to apply to the\n function.

" + "smithy.api#documentation": "

A list of tags to apply to the function.

" } }, "Layers": { "target": "com.amazonaws.lambda#LayerList", "traits": { - "smithy.api#documentation": "

A list of function layers\n to add to the function's execution environment. Specify each layer by its ARN, including the version.

" + "smithy.api#documentation": "

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

" } }, "FileSystemConfigs": { @@ -3022,25 +3063,25 @@ "ImageConfig": { "target": "com.amazonaws.lambda#ImageConfig", "traits": { - "smithy.api#documentation": "

Container image configuration\n values that override the values in the container image Dockerfile.

" + "smithy.api#documentation": "

Container image configuration values that override the values in the container image Dockerfile.

" } }, "CodeSigningConfigArn": { "target": "com.amazonaws.lambda#CodeSigningConfigArn", "traits": { - "smithy.api#documentation": "

To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration\nincludes a set of signing profiles, which define the trusted publishers for this function.

" + "smithy.api#documentation": "

To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

" } }, "Architectures": { "target": "com.amazonaws.lambda#ArchitecturesList", "traits": { - "smithy.api#documentation": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64).\n The default value is x86_64.

" + "smithy.api#documentation": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

" } }, "EphemeralStorage": { "target": "com.amazonaws.lambda#EphemeralStorage", "traits": { - "smithy.api#documentation": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole\n number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" + "smithy.api#documentation": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" } }, "SnapStart": { @@ -3086,7 +3127,20 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Lambda function URL with the specified configuration parameters. A function URL is\n a dedicated HTTP(S) endpoint that you can use to invoke your function.

", + "aws.iam#conditionKeys": [ + "lambda:FunctionArn", + "lambda:FunctionUrlAuthType" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to create a function url configuration for a Lambda function", + "relativeDocumentation": "API_CreateFunctionUrlConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.

", "smithy.api#http": { "method": "POST", "uri": "/2021-10-31/functions/{FunctionName}/url", @@ -3100,7 +3154,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3115,20 +3169,20 @@ "AuthType": { "target": "com.amazonaws.lambda#FunctionUrlAuthType", "traits": { - "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

", + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

", "smithy.api#required": {} } }, "Cors": { "target": "com.amazonaws.lambda#Cors", "traits": { - "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings\n for your function URL.

" + "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings for your function URL.

" } }, "InvokeMode": { "target": "com.amazonaws.lambda#InvokeMode", "traits": { - "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.

    \n
    • \n
  • \n

    \n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

    \n
    • \n
" + "smithy.api#documentation": "

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

" } } }, @@ -3156,14 +3210,14 @@ "AuthType": { "target": "com.amazonaws.lambda#FunctionUrlAuthType", "traits": { - "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

", + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

", "smithy.api#required": {} } }, "Cors": { "target": "com.amazonaws.lambda#Cors", "traits": { - "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings\n for your function URL.

" + "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings for your function URL.

" } }, "CreationTime": { @@ -3176,7 +3230,7 @@ "InvokeMode": { "target": "com.amazonaws.lambda#InvokeMode", "traits": { - "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.

    \n
    • \n
  • \n

    \n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

    \n
    • \n
" + "smithy.api#documentation": "

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

" } } }, @@ -3208,7 +3262,7 @@ } }, "traits": { - "smithy.api#documentation": "

The dead-letter queue for\n failed asynchronous invocations.

" + "smithy.api#documentation": "

The dead-letter queue for failed asynchronous invocations.

" } }, "com.amazonaws.lambda#DeleteAlias": { @@ -3234,6 +3288,15 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Lambda function alias", + "relativeDocumentation": "API_DeleteAlias.html", + "resources": { + "required": { + "function": {} + } + } + }, "smithy.api#documentation": "

Deletes a Lambda function alias.

", "smithy.api#examples": [ { @@ -3249,7 +3312,8 @@ "method": "DELETE", "uri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", "code": 204 - } + }, + "smithy.api#idempotent": {} } }, "com.amazonaws.lambda#DeleteAliasRequest": { @@ -3258,7 +3322,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3268,7 +3332,8 @@ "traits": { "smithy.api#documentation": "

The name of the alias.

", "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Alias" } } }, @@ -3299,12 +3364,22 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the code signing configuration. You can delete the code signing configuration only if no function is\n using it.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Lambda code signing config", + "relativeDocumentation": "API_DeleteCodeSigningConfig.html", + "resources": { + "required": { + "code signing config": {} + } + } + }, + "smithy.api#documentation": "

Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.

", "smithy.api#http": { "method": "DELETE", "uri": "/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", "code": 204 - } + }, + "smithy.api#idempotent": {} } }, "com.amazonaws.lambda#DeleteCodeSigningConfigRequest": { @@ -3359,7 +3434,19 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an event source\n mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

\n

When you delete an event source mapping, it enters a Deleting state and might not be completely\n deleted for several seconds.

", + "aws.iam#conditionKeys": [ + "lambda:FunctionArn" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Lambda event source mapping", + "relativeDocumentation": "API_DeleteEventSourceMapping.html", + "resources": { + "required": { + "eventSourceMapping": {} + } + } + }, + "smithy.api#documentation": "

Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

When you delete an event source mapping, it enters a Deleting state and might not be completely deleted for several seconds.

", "smithy.api#examples": [ { "title": "To delete a Lambda function event source mapping", @@ -3382,7 +3469,8 @@ "method": "DELETE", "uri": "/2015-03-31/event-source-mappings/{UUID}", "code": 202 - } + }, + "smithy.api#idempotent": {} } }, "com.amazonaws.lambda#DeleteEventSourceMappingRequest": { @@ -3427,7 +3515,16 @@ } ], "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 Services services and resources that invoke your function\n directly, delete the trigger in the service where you originally configured it.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to delete an AWS Lambda function", + "relativeDocumentation": "API_DeleteFunction.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit permissions for DeleteAlias.

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.

", "smithy.api#examples": [ { "title": "To delete a version of a Lambda function", @@ -3442,7 +3539,8 @@ "method": "DELETE", "uri": "/2015-03-31/functions/{FunctionName}", "code": 204 - } + }, + "smithy.api#idempotent": {} } }, "com.amazonaws.lambda#DeleteFunctionCodeSigningConfig": { @@ -3474,6 +3572,15 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to detach a code signing config from an AWS Lambda function", + "relativeDocumentation": "API_DeleteFunctionCodeSigningConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, "smithy.api#documentation": "

Removes the code signing configuration from the function.

", "smithy.api#http": { "method": "DELETE", @@ -3488,7 +3595,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3524,6 +3631,15 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to remove a concurrent execution limit from an AWS Lambda function", + "relativeDocumentation": "API_DeleteFunctionConcurrency.html", + "resources": { + "required": { + "function": {} + } + } + }, "smithy.api#documentation": "

Removes a concurrent execution limit from a function.

", "smithy.api#examples": [ { @@ -3547,7 +3663,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3583,7 +3699,16 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the configuration for asynchronous invocation for a function, version, or alias.

\n

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to delete the configuration for asynchronous invocation for an AWS Lambda function, version, or alias", + "relativeDocumentation": "API_DeleteFunctionEventInvokeConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Deletes the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", "smithy.api#examples": [ { "title": "To delete an asynchronous invocation configuration", @@ -3607,7 +3732,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3630,7 +3755,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function or version.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:1 (with version).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function or version.

Name formats

  • Function name – my-function (name-only), my-function:1 (with version).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3670,7 +3795,20 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a Lambda function URL. When you delete a function URL, you\n can't recover it. Creating a new function URL results in a different URL address.

", + "aws.iam#conditionKeys": [ + "lambda:FunctionArn", + "lambda:FunctionUrlAuthType" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to delete function url configuration for a Lambda function", + "relativeDocumentation": "API_DeleteFunctionUrlConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Deletes a Lambda function URL. When you delete a function URL, you can't recover it. Creating a new function URL results in a different URL address.

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-10-31/functions/{FunctionName}/url", @@ -3684,7 +3822,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3718,7 +3856,16 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a version of an Lambda\n layer. Deleted versions can no longer be viewed or added to functions. To avoid\n breaking functions, a copy of the version remains in Lambda until no functions refer to it.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to delete a version of an AWS Lambda layer", + "relativeDocumentation": "API_DeleteLayerVersion.html", + "resources": { + "required": { + "layerVersion": {} + } + } + }, + "smithy.api#documentation": "

Deletes a version of an Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.

", "smithy.api#examples": [ { "title": "To delete a version of a Lambda layer", @@ -3733,7 +3880,8 @@ "method": "DELETE", "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", "code": 204 - } + }, + "smithy.api#idempotent": {} } }, "com.amazonaws.lambda#DeleteLayerVersionRequest": { @@ -3787,6 +3935,16 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete the provisioned concurrency configuration for an AWS Lambda function", + "relativeDocumentation": "API_DeleteProvisionedConcurrencyConfig.html", + "resources": { + "optional": { + "function version": {}, + "function alias": {} + } + } + }, "smithy.api#documentation": "

Deletes the provisioned concurrency configuration for a function.

", "smithy.api#examples": [ { @@ -3802,7 +3960,8 @@ "method": "DELETE", "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency", "code": 204 - } + }, + "smithy.api#idempotent": {} } }, "com.amazonaws.lambda#DeleteProvisionedConcurrencyConfigRequest": { @@ -3811,7 +3970,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3874,24 +4033,24 @@ "DatabaseName": { "target": "com.amazonaws.lambda#DatabaseName", "traits": { - "smithy.api#documentation": "

\n The name of the database to consume within the DocumentDB cluster.\n

" + "smithy.api#documentation": "

The name of the database to consume within the DocumentDB cluster.

" } }, "CollectionName": { "target": "com.amazonaws.lambda#CollectionName", "traits": { - "smithy.api#documentation": "

\n The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.\n

" + "smithy.api#documentation": "

The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.

" } }, "FullDocument": { "target": "com.amazonaws.lambda#FullDocument", "traits": { - "smithy.api#documentation": "

\n Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.\n

" + "smithy.api#documentation": "

Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.

" } } }, "traits": { - "smithy.api#documentation": "

\n Specific configuration settings for a DocumentDB event source.\n

" + "smithy.api#documentation": "

Specific configuration settings for a DocumentDB event source.

" } }, "com.amazonaws.lambda#EC2AccessDeniedException": { @@ -3921,7 +4080,7 @@ } }, "traits": { - "smithy.api#documentation": "

Amazon EC2 throttled Lambda during Lambda function initialization using\n the execution role provided for the function.

", + "smithy.api#documentation": "

Amazon EC2 throttled Lambda during Lambda function initialization using the execution role provided for the function.

", "smithy.api#error": "server", "smithy.api#httpError": 502 } @@ -3940,7 +4099,7 @@ } }, "traits": { - "smithy.api#documentation": "

Lambda received an unexpected Amazon EC2 client exception while setting up for the\n Lambda function.

", + "smithy.api#documentation": "

Lambda received an unexpected Amazon EC2 client exception while setting up for the Lambda function.

", "smithy.api#error": "server", "smithy.api#httpError": 502 } @@ -3988,7 +4147,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Lambda function couldn't mount the configured file system due to a permission or configuration\n issue.

", + "smithy.api#documentation": "

The Lambda function couldn't mount the configured file system due to a permission or configuration issue.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -4004,7 +4163,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Lambda function made a network connection to the configured file system, but the mount\n operation timed out.

", + "smithy.api#documentation": "

The Lambda function made a network connection to the configured file system, but the mount operation timed out.

", "smithy.api#error": "client", "smithy.api#httpError": 408 } @@ -4020,7 +4179,7 @@ } }, "traits": { - "smithy.api#documentation": "

Lambda couldn't create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached. For more\n information, see Lambda\n quotas.

", + "smithy.api#documentation": "

Lambda couldn't create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached. For more information, see Lambda quotas.

", "smithy.api#error": "server", "smithy.api#httpError": 502 } @@ -4087,7 +4246,7 @@ } }, "traits": { - "smithy.api#documentation": "

A function's environment variable settings. You can use environment variables to adjust your function's\n behavior without updating code. An environment variable is a pair of strings that are stored in a function's\n version-specific configuration.

" + "smithy.api#documentation": "

A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.

" } }, "com.amazonaws.lambda#EnvironmentError": { @@ -4127,7 +4286,7 @@ } }, "traits": { - "smithy.api#documentation": "

The results of an operation to update or read environment variables. If the operation succeeds, the response\n contains the environment variables. If it fails, the response contains details about the error.

" + "smithy.api#documentation": "

The results of an operation to update or read environment variables. If the operation succeeds, the response contains the environment variables. If it fails, the response contains details about the error.

" } }, "com.amazonaws.lambda#EnvironmentVariableName": { @@ -4167,7 +4326,7 @@ } }, "traits": { - "smithy.api#documentation": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole\n number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" + "smithy.api#documentation": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" } }, "com.amazonaws.lambda#EphemeralStorageSize": { @@ -4179,6 +4338,46 @@ } } }, + "com.amazonaws.lambda#EventSourceMapping": { + "type": "resource", + "identifiers": { + "UUID": { + "target": "com.amazonaws.lambda#String" + } + }, + "create": { + "target": "com.amazonaws.lambda#CreateEventSourceMapping" + }, + "read": { + "target": "com.amazonaws.lambda#GetEventSourceMapping" + }, + "update": { + "target": "com.amazonaws.lambda#UpdateEventSourceMapping" + }, + "delete": { + "target": "com.amazonaws.lambda#DeleteEventSourceMapping" + }, + "list": { + "target": "com.amazonaws.lambda#ListEventSourceMappings" + }, + "traits": { + "aws.api#arn": { + "template": "event-source-mapping:{UUID}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "eventSourceMapping", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "Represents an AWS Lambda event source mapping", + "smithy.api#suppress": [ + "IamResourceTrait" + ] + } + }, "com.amazonaws.lambda#EventSourceMappingArn": { "type": "string", "traits": { @@ -4201,25 +4400,25 @@ "StartingPosition": { "target": "com.amazonaws.lambda#EventSourcePosition", "traits": { - "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis and\n Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for\n Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

" + "smithy.api#documentation": "

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

" } }, "StartingPositionTimestamp": { "target": "com.amazonaws.lambda#Date", "traits": { - "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start\n reading. StartingPositionTimestamp cannot be in the future.

" + "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

" } }, "BatchSize": { "target": "com.amazonaws.lambda#BatchSize", "traits": { - "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

\n

Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

\n

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" + "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" } }, "MaximumBatchingWindowInSeconds": { "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", "traits": { - "smithy.api#documentation": "

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

\n

For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default\n batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.\n To restore the default batching window, you must create a new event source mapping.

\n

Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" + "smithy.api#documentation": "

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" } }, "ParallelizationFactor": { @@ -4237,7 +4436,7 @@ "FilterCriteria": { "target": "com.amazonaws.lambda#FilterCriteria", "traits": { - "smithy.api#documentation": "

An object that defines the filter criteria that\n determine whether Lambda should process an event. For more information, see Lambda event filtering.

\n

If filter criteria is encrypted, this field shows up as null in the response\n of ListEventSourceMapping API calls. You can view this field in plaintext in the response of\n GetEventSourceMapping and DeleteEventSourceMapping calls if you have\n kms:Decrypt permissions for the correct KMS key.

" + "smithy.api#documentation": "

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

If filter criteria is encrypted, this field shows up as null in the response of ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping and DeleteEventSourceMapping calls if you have kms:Decrypt permissions for the correct KMS key.

" } }, "FunctionArn": { @@ -4261,7 +4460,7 @@ "State": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The state of the event source mapping. It can be one of the following: Creating,\n Enabling, Enabled, Disabling, Disabled,\n Updating, or Deleting.

" + "smithy.api#documentation": "

The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

" } }, "StateTransitionReason": { @@ -4303,7 +4502,7 @@ "MaximumRecordAgeInSeconds": { "target": "com.amazonaws.lambda#MaximumRecordAgeInSeconds", "traits": { - "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1,\nwhich sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

\n \n

The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

\n " + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

" } }, "BisectBatchOnFunctionError": { @@ -4315,7 +4514,7 @@ "MaximumRetryAttempts": { "target": "com.amazonaws.lambda#MaximumRetryAttemptsEventSourceMapping", "traits": { - "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1,\nwhich sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

" + "smithy.api#documentation": "

(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

" } }, "TumblingWindowInSeconds": { @@ -4357,7 +4556,7 @@ "KMSKeyArn": { "target": "com.amazonaws.lambda#KMSKeyArn", "traits": { - "smithy.api#documentation": "

\n The ARN of the Key Management Service (KMS) customer managed key that Lambda\n uses to encrypt your function's filter criteria.

" + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria.

" } }, "FilterCriteriaError": { @@ -4381,7 +4580,7 @@ "ProvisionedPollerConfig": { "target": "com.amazonaws.lambda#ProvisionedPollerConfig", "traits": { - "smithy.api#documentation": "

(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source.\n For more information, see provisioned mode.

" + "smithy.api#documentation": "

(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

" } } }, @@ -4418,12 +4617,12 @@ "Metrics": { "target": "com.amazonaws.lambda#EventSourceMappingMetricList", "traits": { - "smithy.api#documentation": "

\n The metrics you want your event source mapping to produce. Include EventCount to receive event source mapping\n metrics related to the number of events processed by your event source mapping. For more information about these metrics,\n see \n Event source mapping metrics.\n

" + "smithy.api#documentation": "

The metrics you want your event source mapping to produce. Include EventCount to receive event source mapping metrics related to the number of events processed by your event source mapping. For more information about these metrics, see Event source mapping metrics.

" } } }, "traits": { - "smithy.api#documentation": "

The metrics configuration for your event source. Use this configuration object to define which metrics you want your\n event source mapping to produce.

" + "smithy.api#documentation": "

The metrics configuration for your event source. Use this configuration object to define which metrics you want your event source mapping to produce.

" } }, "com.amazonaws.lambda#EventSourceMappingsList": { @@ -4481,7 +4680,7 @@ "Arn": { "target": "com.amazonaws.lambda#FileSystemArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file\n system.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.

", "smithy.api#required": {} } }, @@ -4515,12 +4714,12 @@ "Pattern": { "target": "com.amazonaws.lambda#Pattern", "traits": { - "smithy.api#documentation": "

\n A filter pattern. For more information on the syntax of a filter pattern, see\n \n Filter rule syntax.\n

" + "smithy.api#documentation": "

A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax.

" } } }, "traits": { - "smithy.api#documentation": "

\n A structure within a FilterCriteria object that defines an event filtering pattern.\n

" + "smithy.api#documentation": "

A structure within a FilterCriteria object that defines an event filtering pattern.

" } }, "com.amazonaws.lambda#FilterCriteria": { @@ -4529,12 +4728,12 @@ "Filters": { "target": "com.amazonaws.lambda#FilterList", "traits": { - "smithy.api#documentation": "

\n A list of filters.\n

" + "smithy.api#documentation": "

A list of filters.

" } } }, "traits": { - "smithy.api#documentation": "

\n An object that contains the filters for an event source.\n

" + "smithy.api#documentation": "

An object that contains the filters for an event source.

" } }, "com.amazonaws.lambda#FilterCriteriaError": { @@ -4600,6 +4799,178 @@ } } }, + "com.amazonaws.lambda#Function": { + "type": "resource", + "identifiers": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName" + } + }, + "put": { + "target": "com.amazonaws.lambda#CreateFunction" + }, + "delete": { + "target": "com.amazonaws.lambda#DeleteFunction" + }, + "list": { + "target": "com.amazonaws.lambda#ListFunctions" + }, + "operations": [ + { + "target": "com.amazonaws.lambda#CreateFunctionUrlConfig" + }, + { + "target": "com.amazonaws.lambda#DeleteFunctionCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#DeleteFunctionConcurrency" + }, + { + "target": "com.amazonaws.lambda#DeleteFunctionEventInvokeConfig" + }, + { + "target": "com.amazonaws.lambda#DeleteFunctionUrlConfig" + }, + { + "target": "com.amazonaws.lambda#GetFunctionCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#GetFunctionConcurrency" + }, + { + "target": "com.amazonaws.lambda#GetFunctionEventInvokeConfig" + }, + { + "target": "com.amazonaws.lambda#GetFunctionUrlConfig" + }, + { + "target": "com.amazonaws.lambda#ListFunctionEventInvokeConfigs" + }, + { + "target": "com.amazonaws.lambda#ListFunctionUrlConfigs" + }, + { + "target": "com.amazonaws.lambda#ListProvisionedConcurrencyConfigs" + }, + { + "target": "com.amazonaws.lambda#PutFunctionCodeSigningConfig" + }, + { + "target": "com.amazonaws.lambda#PutFunctionConcurrency" + }, + { + "target": "com.amazonaws.lambda#PutFunctionEventInvokeConfig" + }, + { + "target": "com.amazonaws.lambda#PutRuntimeManagementConfig" + }, + { + "target": "com.amazonaws.lambda#UpdateFunctionCode" + }, + { + "target": "com.amazonaws.lambda#UpdateFunctionConfiguration" + }, + { + "target": "com.amazonaws.lambda#UpdateFunctionEventInvokeConfig" + }, + { + "target": "com.amazonaws.lambda#UpdateFunctionUrlConfig" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.lambda#GetFunction" + }, + { + "target": "com.amazonaws.lambda#GetFunctionConfiguration" + }, + { + "target": "com.amazonaws.lambda#GetFunctionRecursionConfig" + }, + { + "target": "com.amazonaws.lambda#GetPolicy" + }, + { + "target": "com.amazonaws.lambda#GetRuntimeManagementConfig" + }, + { + "target": "com.amazonaws.lambda#Invoke" + }, + { + "target": "com.amazonaws.lambda#InvokeAsync" + }, + { + "target": "com.amazonaws.lambda#InvokeWithResponseStream" + }, + { + "target": "com.amazonaws.lambda#PutFunctionRecursionConfig" + } + ], + "traits": { + "aws.api#arn": { + "template": "function:{FunctionName}" + }, + "aws.api#taggable": { + "property": "Tags", + "disableSystemTags": false + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "function", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "Represents an AWS Lambda function", + "smithy.api#suppress": [ + "TaggableResource" + ] + } + }, + "com.amazonaws.lambda#FunctionAlias": { + "type": "resource", + "identifiers": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName" + }, + "Alias": { + "target": "com.amazonaws.lambda#Alias" + } + }, + "put": { + "target": "com.amazonaws.lambda#CreateAlias" + }, + "read": { + "target": "com.amazonaws.lambda#GetAlias" + }, + "update": { + "target": "com.amazonaws.lambda#UpdateAlias" + }, + "delete": { + "target": "com.amazonaws.lambda#DeleteAlias" + }, + "list": { + "target": "com.amazonaws.lambda#ListAliases" + }, + "traits": { + "aws.api#arn": { + "template": "function:{FunctionName}:{Alias}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "function alias", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "A lambda function version or alias", + "smithy.api#suppress": [ + "IamResourceTrait" + ] + } + }, "com.amazonaws.lambda#FunctionArn": { "type": "string", "traits": { @@ -4618,7 +4989,7 @@ "ZipFile": { "target": "com.amazonaws.lambda#Blob", "traits": { - "smithy.api#documentation": "

The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for\n you.

" + "smithy.api#documentation": "

The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you.

" } }, "S3Bucket": { @@ -4642,18 +5013,18 @@ "ImageUri": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

URI of a container image in the\n Amazon ECR registry.

" + "smithy.api#documentation": "

URI of a container image in the Amazon ECR registry.

" } }, "SourceKMSKeyArn": { "target": "com.amazonaws.lambda#KMSKeyArn", "traits": { - "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's \n.zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.

" + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.

" } } }, "traits": { - "smithy.api#documentation": "

The code for the Lambda function. You can either specify an object in Amazon S3, upload a\n .zip file archive deployment package directly, or specify the URI of a container image.

" + "smithy.api#documentation": "

The code for the Lambda function. You can either specify an object in Amazon S3, upload a .zip file archive deployment package directly, or specify the URI of a container image.

" } }, "com.amazonaws.lambda#FunctionCodeLocation": { @@ -4686,7 +5057,7 @@ "SourceKMSKeyArn": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's \n.zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.

" + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key.

" } } }, @@ -4712,7 +5083,7 @@ "Runtime": { "target": "com.amazonaws.lambda#Runtime", "traits": { - "smithy.api#documentation": "

The identifier of the function's \n runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in\n an error if you're deploying a function using a container image.

\n

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing\n functions shortly after each runtime is deprecated. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

" + "smithy.api#documentation": "

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" } }, "Role": { @@ -4791,7 +5162,7 @@ "KMSKeyArn": { "target": "com.amazonaws.lambda#KMSKeyArn", "traits": { - "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

\n
    \n
  • \n

    The function's environment variables.

    \n
    • \n
  • \n

    The function's Lambda SnapStart snapshots.

    \n
    • \n
  • \n

    When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see \n Specifying a customer managed key for Lambda.

    \n
    • \n
  • \n

    The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

    \n
    • \n
\n

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

" + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

  • The function's environment variables.

  • The function's Lambda SnapStart snapshots.

  • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

  • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

" } }, "TracingConfig": { @@ -4821,7 +5192,7 @@ "State": { "target": "com.amazonaws.lambda#State", "traits": { - "smithy.api#documentation": "

The current state of the function. When the state is Inactive, you can reactivate the function by\n invoking it.

" + "smithy.api#documentation": "

The current state of the function. When the state is Inactive, you can reactivate the function by invoking it.

" } }, "StateReason": { @@ -4833,13 +5204,13 @@ "StateReasonCode": { "target": "com.amazonaws.lambda#StateReasonCode", "traits": { - "smithy.api#documentation": "

The reason code for the function's current state. When the code is Creating, you can't invoke or\n modify the function.

" + "smithy.api#documentation": "

The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function.

" } }, "LastUpdateStatus": { "target": "com.amazonaws.lambda#LastUpdateStatus", "traits": { - "smithy.api#documentation": "

The status of the last update that was performed on the function. This is first set to Successful\n after function creation completes.

" + "smithy.api#documentation": "

The status of the last update that was performed on the function. This is first set to Successful after function creation completes.

" } }, "LastUpdateStatusReason": { @@ -4887,19 +5258,19 @@ "Architectures": { "target": "com.amazonaws.lambda#ArchitecturesList", "traits": { - "smithy.api#documentation": "

The instruction set architecture that the function supports. Architecture is a string array with one of the \n valid values. The default architecture value is x86_64.

" + "smithy.api#documentation": "

The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.

" } }, "EphemeralStorage": { "target": "com.amazonaws.lambda#EphemeralStorage", "traits": { - "smithy.api#documentation": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole\n number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" + "smithy.api#documentation": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" } }, "SnapStart": { "target": "com.amazonaws.lambda#SnapStartResponse", "traits": { - "smithy.api#documentation": "

Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution\n environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

" + "smithy.api#documentation": "

Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart.

" } }, "RuntimeVersionConfig": { @@ -4949,7 +5320,7 @@ "DestinationConfig": { "target": "com.amazonaws.lambda#DestinationConfig", "traits": { - "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

\n

\n Destinations\n

\n
    \n
  • \n

    \n Function - The Amazon Resource Name (ARN) of a Lambda function.

    \n
    • \n
  • \n

    \n Queue - The ARN of a standard SQS queue.

    \n
    • \n
  • \n

    \n Bucket - The ARN of an Amazon S3 bucket.

    \n
    • \n
  • \n

    \n Topic - The ARN of a standard SNS topic.

    \n
    • \n
  • \n

    \n Event Bus - The ARN of an Amazon EventBridge event bus.

    \n
    • \n
\n \n

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

\n " + "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

Destinations

  • Function - The Amazon Resource Name (ARN) of a Lambda function.

  • Queue - The ARN of a standard SQS queue.

  • Bucket - The ARN of an Amazon S3 bucket.

  • Topic - The ARN of a standard SNS topic.

  • Event Bus - The ARN of an Amazon EventBridge event bus.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

" } } } @@ -5059,20 +5430,20 @@ "Cors": { "target": "com.amazonaws.lambda#Cors", "traits": { - "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings\n for your function URL.

" + "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings for your function URL.

" } }, "AuthType": { "target": "com.amazonaws.lambda#FunctionUrlAuthType", "traits": { - "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

", + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

", "smithy.api#required": {} } }, "InvokeMode": { "target": "com.amazonaws.lambda#InvokeMode", "traits": { - "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n BUFFERED – This is the default option. Lambda invokes your function\n using the Invoke API operation. Invocation results are available when the\n payload is complete. The maximum payload size is 6 MB.

    \n
    • \n
  • \n

    \n RESPONSE_STREAM – Your function streams payload results as they become available.\n Lambda invokes your function using the InvokeWithResponseStream\n API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

    \n
    • \n
" + "smithy.api#documentation": "

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

" } } }, @@ -5107,6 +5478,42 @@ } } }, + "com.amazonaws.lambda#FunctionVersionResource": { + "type": "resource", + "identifiers": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName" + }, + "Version": { + "target": "com.amazonaws.lambda#Version" + } + }, + "create": { + "target": "com.amazonaws.lambda#PublishVersion" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.lambda#ListVersionsByFunction" + } + ], + "traits": { + "aws.api#arn": { + "template": "function:{FunctionName}:{Version}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "function version", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "A lambda function version or alias", + "smithy.api#suppress": [ + "IamResourceTrait" + ] + } + }, "com.amazonaws.lambda#GetAccountSettings": { "type": "operation", "input": { @@ -5124,6 +5531,10 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about an account's limits and usage in an AWS Region", + "relativeDocumentation": "API_GetAccountSettings.html" + }, "smithy.api#documentation": "

Retrieves details about your account's limits and usage in an Amazon Web Services Region.

", "smithy.api#examples": [ { @@ -5148,7 +5559,8 @@ "method": "GET", "uri": "/2016-08-19/account-settings", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetAccountSettingsRequest": { @@ -5201,6 +5613,15 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about an AWS Lambda function alias", + "relativeDocumentation": "API_GetAlias.html", + "resources": { + "required": { + "function": {} + } + } + }, "smithy.api#documentation": "

Returns details about a Lambda function alias.

", "smithy.api#examples": [ { @@ -5223,7 +5644,8 @@ "method": "GET", "uri": "/2015-03-31/functions/{FunctionName}/aliases/{Name}", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetAliasRequest": { @@ -5232,7 +5654,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5242,7 +5664,8 @@ "traits": { "smithy.api#documentation": "

The name of the alias.

", "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Alias" } } }, @@ -5270,12 +5693,22 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about an AWS Lambda code signing config", + "relativeDocumentation": "API_GetCodeSigningConfig.html", + "resources": { + "required": { + "code signing config": {} + } + } + }, "smithy.api#documentation": "

Returns information about the specified code signing configuration.

", "smithy.api#http": { "method": "GET", "uri": "/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetCodeSigningConfigRequest": { @@ -5332,7 +5765,19 @@ } ], "traits": { - "smithy.api#documentation": "

Returns details about an event source mapping. You can get the identifier of a mapping from the output of\n ListEventSourceMappings.

", + "aws.iam#conditionKeys": [ + "lambda:FunctionArn" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about an AWS Lambda event source mapping", + "relativeDocumentation": "API_GetEventSourceMapping.html", + "resources": { + "required": { + "eventSourceMapping": {} + } + } + }, + "smithy.api#documentation": "

Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

", "smithy.api#examples": [ { "title": "To get a Lambda function's event source mapping", @@ -5360,7 +5805,8 @@ "method": "GET", "uri": "/2015-03-31/event-source-mappings/{UUID}", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetEventSourceMappingRequest": { @@ -5402,7 +5848,16 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about the function or function version, with a link to download the deployment package\n that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are\n returned.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about an AWS Lambda function", + "relativeDocumentation": "API_GetFunction.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.

", "smithy.api#examples": [ { "title": "To get a Lambda function", @@ -5454,6 +5909,7 @@ "uri": "/2015-03-31/functions/{FunctionName}", "code": 200 }, + "smithy.api#readonly": {}, "smithy.waiters#waitable": { "FunctionActiveV2": { "documentation": "Waits for the function's State to be Active. This waiter uses GetFunction API. This should be used after new function creation.", @@ -5489,7 +5945,8 @@ } } ], - "minDelay": 1 + "minDelay": 1, + "maxDelay": 300 }, "FunctionExists": { "acceptors": [ @@ -5506,7 +5963,8 @@ } } ], - "minDelay": 1 + "minDelay": 1, + "maxDelay": 20 }, "FunctionUpdatedV2": { "documentation": "Waits for the function's LastUpdateStatus to be Successful. This waiter uses GetFunction API. This should be used after function updates.", @@ -5542,7 +6000,8 @@ } } ], - "minDelay": 1 + "minDelay": 1, + "maxDelay": 300 } } } @@ -5570,12 +6029,22 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view the code signing config arn attached to an AWS Lambda function", + "relativeDocumentation": "API_GetFunctionCodeSigningConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, "smithy.api#documentation": "

Returns the code signing configuration for the specified function.

", "smithy.api#http": { "method": "GET", "uri": "/2020-06-30/functions/{FunctionName}/code-signing-config", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetFunctionCodeSigningConfigRequest": { @@ -5584,7 +6053,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5607,7 +6076,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#required": {} } } @@ -5639,7 +6108,16 @@ } ], "traits": { - "smithy.api#documentation": "

Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a\n function, use PutFunctionConcurrency.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about the reserved concurrency configuration for a function", + "relativeDocumentation": "API_GetFunctionConcurrency.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.

", "smithy.api#examples": [ { "title": "To get the reserved concurrency setting for a function", @@ -5656,7 +6134,8 @@ "method": "GET", "uri": "/2019-09-30/functions/{FunctionName}/concurrency", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetFunctionConcurrencyRequest": { @@ -5665,7 +6144,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5712,7 +6191,16 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the version-specific settings of a Lambda function or version. The output includes only options that\n can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.

\n

To get all of a function's details, including function-level settings, use GetFunction.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about the version-specific settings of an AWS Lambda function or version", + "relativeDocumentation": "API_GetFunctionConfiguration.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.

To get all of a function's details, including function-level settings, use GetFunction.

", "smithy.api#examples": [ { "title": "To get a Lambda function's event source mapping", @@ -5755,6 +6243,7 @@ "uri": "/2015-03-31/functions/{FunctionName}/configuration", "code": 200 }, + "smithy.api#readonly": {}, "smithy.waiters#waitable": { "FunctionActive": { "documentation": "Waits for the function's State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new function creation.", @@ -5790,7 +6279,8 @@ } } ], - "minDelay": 5 + "minDelay": 5, + "maxDelay": 300 }, "FunctionUpdated": { "documentation": "Waits for the function's LastUpdateStatus to be Successful. This waiter uses GetFunctionConfiguration API. This should be used after function updates.", @@ -5826,7 +6316,8 @@ } } ], - "minDelay": 5 + "minDelay": 5, + "maxDelay": 300 }, "PublishedVersionActive": { "documentation": "Waits for the published version's State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new version is published.", @@ -5862,7 +6353,8 @@ } } ], - "minDelay": 5 + "minDelay": 5, + "maxDelay": 1560 } } } @@ -5873,7 +6365,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5913,7 +6405,16 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

\n

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to view the configuration for asynchronous invocation for a function, version, or alias", + "relativeDocumentation": "API_GetFunctionEventInvokeConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", "smithy.api#examples": [ { "title": "To get an asynchronous invocation configuration", @@ -5940,7 +6441,8 @@ "method": "GET", "uri": "/2019-09-25/functions/{FunctionName}/event-invoke-config", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetFunctionEventInvokeConfigRequest": { @@ -5949,7 +6451,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5989,12 +6491,22 @@ } ], "traits": { - "smithy.api#documentation": "

Returns your function's recursive loop detection configuration. \n

", + "aws.iam#iamAction": { + "documentation": "Grants permission to view the recursion configuration of an AWS Lambda function", + "relativeDocumentation": "API_GetFunctionRecursionConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Returns your function's recursive loop detection configuration.

", "smithy.api#http": { "method": "GET", "uri": "/2024-08-31/functions/{FunctionName}/recursion-config", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetFunctionRecursionConfigRequest": { @@ -6003,7 +6515,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#UnqualifiedFunctionName", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6019,7 +6531,7 @@ "RecursiveLoop": { "target": "com.amazonaws.lambda#RecursiveLoop", "traits": { - "smithy.api#documentation": "

If your function's recursive loop detection configuration is Allow, Lambda doesn't take any action when it \n detects your function being invoked as part of a recursive loop.

\n

If your function's recursive loop detection configuration is Terminate, Lambda stops your function being \n invoked and notifies you when it detects your function being invoked as part of a recursive loop.

\n

By default, Lambda sets your function's configuration to Terminate. You can update this \n configuration using the PutFunctionRecursionConfig action.

" + "smithy.api#documentation": "

If your function's recursive loop detection configuration is Allow, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop.

If your function's recursive loop detection configuration is Terminate, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.

By default, Lambda sets your function's configuration to Terminate. You can update this configuration using the PutFunctionRecursionConfig action.

" } } }, @@ -6033,7 +6545,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6068,7 +6580,7 @@ "Tags": { "target": "com.amazonaws.lambda#Tags", "traits": { - "smithy.api#documentation": "

The function's tags. Lambda\n returns tag data only if you have explicit allow permissions for lambda:ListTags.

" + "smithy.api#documentation": "

The function's tags. Lambda returns tag data only if you have explicit allow permissions for lambda:ListTags.

" } }, "TagsError": { @@ -6080,7 +6592,7 @@ "Concurrency": { "target": "com.amazonaws.lambda#Concurrency", "traits": { - "smithy.api#documentation": "

The function's reserved\n concurrency.

" + "smithy.api#documentation": "

The function's reserved concurrency.

" } } }, @@ -6111,12 +6623,26 @@ } ], "traits": { + "aws.iam#conditionKeys": [ + "lambda:FunctionArn", + "lambda:FunctionUrlAuthType" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to read function url configuration for a Lambda function", + "relativeDocumentation": "API_GetFunctionUrlConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, "smithy.api#documentation": "

Returns details about a Lambda function URL.

", "smithy.api#http": { "method": "GET", "uri": "/2021-10-31/functions/{FunctionName}/url", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetFunctionUrlConfigRequest": { @@ -6125,7 +6651,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6162,14 +6688,14 @@ "AuthType": { "target": "com.amazonaws.lambda#FunctionUrlAuthType", "traits": { - "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

", + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

", "smithy.api#required": {} } }, "Cors": { "target": "com.amazonaws.lambda#Cors", "traits": { - "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings\n for your function URL.

" + "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings for your function URL.

" } }, "CreationTime": { @@ -6189,7 +6715,7 @@ "InvokeMode": { "target": "com.amazonaws.lambda#InvokeMode", "traits": { - "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.

    \n
    • \n
  • \n

    \n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

    \n
    • \n
" + "smithy.api#documentation": "

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

" } } }, @@ -6220,7 +6746,16 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a version of an Lambda\n layer, with a link to download the layer archive\n that's valid for 10 minutes.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to view details about a version of an AWS Lambda layer. Note this action also supports GetLayerVersionByArn API", + "relativeDocumentation": "API_GetLayerVersion.html", + "resources": { + "required": { + "layerVersion": {} + } + } + }, + "smithy.api#documentation": "

Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

", "smithy.api#examples": [ { "title": "To get information about a Lambda layer version", @@ -6252,7 +6787,8 @@ "method": "GET", "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetLayerVersionByArn": { @@ -6278,7 +6814,17 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a version of an Lambda\n layer, with a link to download the layer archive\n that's valid for 10 minutes.

", + "aws.iam#iamAction": { + "name": "GetLayerVersion", + "documentation": "Grants permission to view details about a version of an AWS Lambda layer. Note this action also supports GetLayerVersionByArn API", + "relativeDocumentation": "API_GetLayerVersion.html", + "resources": { + "required": { + "layerVersion": {} + } + } + }, + "smithy.api#documentation": "

Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

", "smithy.api#examples": [ { "title": "To get information about a Lambda layer version", @@ -6307,7 +6853,8 @@ "method": "GET", "uri": "/2018-10-31/layers?find=LayerVersion", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetLayerVersionByArnRequest": { @@ -6349,12 +6896,22 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the permission policy for a version of an Lambda\n layer. For more information, see AddLayerVersionPermission.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to view the resource-based policy for a version of an AWS Lambda layer", + "relativeDocumentation": "API_GetLayerVersionPolicy.html", + "resources": { + "required": { + "layerVersion": {} + } + } + }, + "smithy.api#documentation": "

Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.

", "smithy.api#http": { "method": "GET", "uri": "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetLayerVersionPolicyRequest": { @@ -6470,7 +7027,7 @@ "CompatibleRuntimes": { "target": "com.amazonaws.lambda#CompatibleRuntimes", "traits": { - "smithy.api#documentation": "

The layer's compatible runtimes.

\n

The following list includes deprecated runtimes. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

" + "smithy.api#documentation": "

The layer's compatible runtimes.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" } }, "LicenseInfo": { @@ -6482,7 +7039,7 @@ "CompatibleArchitectures": { "target": "com.amazonaws.lambda#CompatibleArchitectures", "traits": { - "smithy.api#documentation": "

A list of compatible \ninstruction set architectures.

" + "smithy.api#documentation": "

A list of compatible instruction set architectures.

" } } } @@ -6510,6 +7067,15 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view the resource-based policy for an AWS Lambda function, version, or alias", + "relativeDocumentation": "API_GetPolicy.html", + "resources": { + "required": { + "function": {} + } + } + }, "smithy.api#documentation": "

Returns the resource-based IAM policy for a function, version, or alias.

", "smithy.api#examples": [ { @@ -6529,7 +7095,8 @@ "method": "GET", "uri": "/2015-03-31/functions/{FunctionName}/policy", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetPolicyRequest": { @@ -6538,7 +7105,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6601,6 +7168,16 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to view the provisioned concurrency configuration for an AWS Lambda function's alias or version", + "relativeDocumentation": "API_GetProvisionedConcurrencyConfig.html", + "resources": { + "optional": { + "function version": {}, + "function alias": {} + } + } + }, "smithy.api#documentation": "

Retrieves the provisioned concurrency configuration for a function's alias or version.

", "smithy.api#examples": [ { @@ -6638,7 +7215,8 @@ "method": "GET", "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetProvisionedConcurrencyConfigRequest": { @@ -6647,7 +7225,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6732,12 +7310,22 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the runtime management configuration for a function's version. If the runtime update mode is Manual, this includes the ARN of the \n runtime version and the runtime update mode. If the runtime update mode is Auto or Function update, \n this includes the runtime update mode and null is returned for the ARN. For more information, see Runtime updates.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to view the runtime management configuration of an AWS Lambda function", + "relativeDocumentation": "API_GetRuntimeManagementConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Retrieves the runtime management configuration for a function's version. If the runtime update mode is Manual, this includes the ARN of the runtime version and the runtime update mode. If the runtime update mode is Auto or Function update, this includes the runtime update mode and null is returned for the ARN. For more information, see Runtime updates.

", "smithy.api#http": { "method": "GET", "uri": "/2021-07-20/functions/{FunctionName}/runtime-management-config", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#GetRuntimeManagementConfigRequest": { @@ -6746,7 +7334,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6754,7 +7342,7 @@ "Qualifier": { "target": "com.amazonaws.lambda#Qualifier", "traits": { - "smithy.api#documentation": "

Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the \n $LATEST version is returned.

", + "smithy.api#documentation": "

Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.

", "smithy.api#httpQuery": "Qualifier" } } @@ -6775,7 +7363,7 @@ "RuntimeVersionArn": { "target": "com.amazonaws.lambda#RuntimeVersionArn", "traits": { - "smithy.api#documentation": "

The ARN of the runtime the function is configured to use. If the runtime update mode is Manual, the ARN is returned, otherwise null \n is returned.

" + "smithy.api#documentation": "

The ARN of the runtime the function is configured to use. If the runtime update mode is Manual, the ARN is returned, otherwise null is returned.

" } }, "FunctionArn": { @@ -6833,7 +7421,7 @@ "EntryPoint": { "target": "com.amazonaws.lambda#StringList", "traits": { - "smithy.api#documentation": "

Specifies the entry point to their application, which is typically the location of the runtime\n executable.

" + "smithy.api#documentation": "

Specifies the entry point to their application, which is typically the location of the runtime executable.

" } }, "Command": { @@ -6850,7 +7438,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration values that override the container image Dockerfile settings. For more information, see Container image\n settings.

" + "smithy.api#documentation": "

Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.

" } }, "com.amazonaws.lambda#ImageConfigError": { @@ -6910,7 +7498,7 @@ } }, "traits": { - "smithy.api#documentation": "

The code signature failed the integrity check. If the integrity check fails, then Lambda blocks\n deployment, even if the code signing policy is set to WARN.

", + "smithy.api#documentation": "

The code signature failed the integrity check. If the integrity check fails, then Lambda blocks deployment, even if the code signing policy is set to WARN.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6954,7 +7542,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request body could not be parsed as JSON, or a request header is invalid. For example, the 'x-amzn-RequestId'\n header is not a valid UUID string.

", + "smithy.api#documentation": "

The request body could not be parsed as JSON, or a request header is invalid. For example, the 'x-amzn-RequestId' header is not a valid UUID string.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7029,7 +7617,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7037,7 +7625,7 @@ "InvocationType": { "target": "com.amazonaws.lambda#InvocationType", "traits": { - "smithy.api#documentation": "

Choose from the following options.

\n
    \n
  • \n

    \n RequestResponse (default) – Invoke the function synchronously. Keep the connection open until\n the function returns a response or times out. The API response includes the function response and additional\n data.

    \n
    • \n
  • \n

    \n Event – Invoke the function asynchronously. Send events that fail multiple times to the\n function's dead-letter queue (if one is configured). The API response only includes a status code.

    \n
    • \n
  • \n

    \n DryRun – Validate parameter values and verify that the user or role has permission to invoke\n the function.

    \n
    • \n
", + "smithy.api#documentation": "

Choose from the following options.

  • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.

  • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

  • DryRun – Validate parameter values and verify that the user or role has permission to invoke the function.

", "smithy.api#httpHeader": "X-Amz-Invocation-Type" } }, @@ -7051,14 +7639,14 @@ "ClientContext": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context\n object. Lambda passes the ClientContext object to your function for\n synchronous invocations only.

", + "smithy.api#documentation": "

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

", "smithy.api#httpHeader": "X-Amz-Client-Context" } }, "Payload": { "target": "com.amazonaws.lambda#Blob", "traits": { - "smithy.api#documentation": "

The JSON that you want to provide to your Lambda function as input.

\n

You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also\n specify a file path. For example, --payload file://payload.json.

", + "smithy.api#documentation": "

The JSON that you want to provide to your Lambda function as input.

You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also specify a file path. For example, --payload file://payload.json.

", "smithy.api#httpPayload": {} } }, @@ -7081,14 +7669,14 @@ "target": "com.amazonaws.lambda#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status code is in the 200 range for a successful request. For the RequestResponse\n invocation type, this status code is 200. For the Event invocation type, this status code is 202. For\n the DryRun invocation type, the status code is 204.

", + "smithy.api#documentation": "

The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204.

", "smithy.api#httpResponseCode": {} } }, "FunctionError": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

If present, indicates that an error occurred during function execution. Details about the error are included\n in the response payload.

", + "smithy.api#documentation": "

If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.

", "smithy.api#httpHeader": "X-Amz-Function-Error" } }, @@ -7109,7 +7697,7 @@ "ExecutedVersion": { "target": "com.amazonaws.lambda#Version", "traits": { - "smithy.api#documentation": "

The version of the function that executed. When you invoke a function with an alias, this indicates which\n version the alias resolved to.

", + "smithy.api#documentation": "

The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.

", "smithy.api#httpHeader": "X-Amz-Executed-Version" } } @@ -7242,7 +7830,20 @@ } ], "traits": { - "smithy.api#documentation": "

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or\n asynchronously. By default, Lambda invokes your function synchronously (i.e. theInvocationType\n is RequestResponse). To invoke a function asynchronously, set InvocationType to\n Event. Lambda passes the ClientContext object to your function for\n synchronous invocations only.

\n

For synchronous invocation,\n details about the function response, including errors, are included in the response body and headers. For either\n invocation type, you can find more information in the execution log and trace.

\n

When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type,\n client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an\n error, Lambda executes the function up to two more times. For more information, see Error handling and automatic retries in\n Lambda.

\n

For asynchronous invocation,\n Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity\n to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple\n times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.

\n

The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that\n prevent your function from executing, such as permissions errors, quota errors, or issues with your function's code and\n configuration. For example, Lambda returns TooManyRequestsException if running the\n function would cause you to exceed a concurrency limit at either the account level\n (ConcurrentInvocationLimitExceeded) or function level\n (ReservedFunctionConcurrentInvocationLimitExceeded).

\n

For functions with a long timeout, your client might disconnect during synchronous invocation while it waits\n for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long\n connections with timeout or keep-alive settings.

\n

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up\n permissions for cross-account invocations, see Granting function\n access to other accounts.

", + "aws.iam#conditionKeys": [ + "lambda:EventSourceToken" + ], + "aws.iam#iamAction": { + "name": "InvokeFunction", + "documentation": "Grants permission to invoke an AWS Lambda function", + "relativeDocumentation": "API_Invoke.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. By default, Lambda invokes your function synchronously (i.e. theInvocationType is RequestResponse). To invoke a function asynchronously, set InvocationType to Event. Lambda passes the ClientContext object to your function for synchronous invocations only.

For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace.

When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Error handling and automatic retries in Lambda.

For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.

The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, quota errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if running the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded).

For functions with a long timeout, your client might disconnect during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.

", "smithy.api#examples": [ { "title": "To invoke a Lambda function", @@ -7276,7 +7877,22 @@ "method": "POST", "uri": "/2015-03-31/functions/{FunctionName}/invocations", "code": 200 - } + }, + "smithy.test#smokeTests": [ + { + "id": "ErrorInvalidFunctionName", + "params": { + "FunctionName": "bogus-function" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.lambda#ResourceNotFoundException" + } + }, + "vendorParams": {}, + "vendorParamsShape": "aws.test#AwsVendorParams" + } + ] } }, "com.amazonaws.lambda#InvokeAsync": { @@ -7305,8 +7921,17 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to invoke a function asynchronously (Deprecated)", + "relativeDocumentation": "API_InvokeAsync.html", + "resources": { + "required": { + "function": {} + } + } + }, "smithy.api#deprecated": {}, - "smithy.api#documentation": "\n

For asynchronous function invocation, use Invoke.

\n \n

Invokes a function asynchronously.

\n \n

If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not \n propagated to the function, even if X-Ray active tracing is turned on.

\n ", + "smithy.api#documentation": "

For asynchronous function invocation, use Invoke.

Invokes a function asynchronously.

If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not propagated to the function, even if X-Ray active tracing is turned on.

", "smithy.api#examples": [ { "title": "To invoke a Lambda function asynchronously", @@ -7324,7 +7949,10 @@ "method": "POST", "uri": "/2014-11-13/functions/{FunctionName}/invoke-async", "code": 202 - } + }, + "smithy.api#suppress": [ + "DeprecatedShape" + ] } }, "com.amazonaws.lambda#InvokeAsyncRequest": { @@ -7333,7 +7961,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7503,7 +8131,20 @@ } ], "traits": { - "smithy.api#documentation": "

Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses.

\n

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up\n permissions for cross-account invocations, see Granting function\n access to other accounts.

", + "aws.iam#conditionKeys": [ + "lambda:EventSourceToken" + ], + "aws.iam#iamAction": { + "name": "InvokeFunction", + "documentation": "Grants permission to invoke an AWS Lambda function", + "relativeDocumentation": "API_Invoke.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses.

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.

", "smithy.api#http": { "method": "POST", "uri": "/2021-11-15/functions/{FunctionName}/response-streaming-invocations", @@ -7543,7 +8184,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7551,7 +8192,7 @@ "InvocationType": { "target": "com.amazonaws.lambda#ResponseStreamingInvocationType", "traits": { - "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n RequestResponse (default) – Invoke the function synchronously. Keep the\n connection open until the function returns a response or times out. The API operation\n response includes the function response and additional data.

    \n
    • \n
  • \n

    \n DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke\n the function.

    \n
    • \n
", + "smithy.api#documentation": "

Use one of the following options:

  • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data.

  • DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke the function.

", "smithy.api#httpHeader": "X-Amz-Invocation-Type" } }, @@ -7565,7 +8206,7 @@ "ClientContext": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context\n object.

", + "smithy.api#documentation": "

Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

", "smithy.api#httpHeader": "X-Amz-Client-Context" } }, @@ -7579,7 +8220,7 @@ "Payload": { "target": "com.amazonaws.lambda#Blob", "traits": { - "smithy.api#documentation": "

The JSON that you want to provide to your Lambda function as input.

\n

You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also\n specify a file path. For example, --payload file://payload.json.

", + "smithy.api#documentation": "

The JSON that you want to provide to your Lambda function as input.

You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also specify a file path. For example, --payload file://payload.json.

", "smithy.api#httpPayload": {} } } @@ -7595,14 +8236,14 @@ "target": "com.amazonaws.lambda#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

For a successful request, the HTTP status code is in the 200 range. For the\n RequestResponse invocation type, this status code is 200. For the DryRun\n invocation type, this status code is 204.

", + "smithy.api#documentation": "

For a successful request, the HTTP status code is in the 200 range. For the RequestResponse invocation type, this status code is 200. For the DryRun invocation type, this status code is 204.

", "smithy.api#httpResponseCode": {} } }, "ExecutedVersion": { "target": "com.amazonaws.lambda#Version", "traits": { - "smithy.api#documentation": "

The version of the function that executed. When you invoke a function with an alias, this\n indicates which version the alias resolved to.

", + "smithy.api#documentation": "

The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.

", "smithy.api#httpHeader": "X-Amz-Executed-Version" } }, @@ -7637,7 +8278,7 @@ "InvokeComplete": { "target": "com.amazonaws.lambda#InvokeWithResponseStreamCompleteEvent", "traits": { - "smithy.api#documentation": "

An object that's returned when the stream has ended and all the payload chunks have been\n returned.

" + "smithy.api#documentation": "

An object that's returned when the stream has ended and all the payload chunks have been returned.

" } } }, @@ -7657,7 +8298,7 @@ } }, "traits": { - "smithy.api#documentation": "

Lambda couldn't decrypt the environment variables because KMS access was denied.\n Check the Lambda function's KMS permissions.

", + "smithy.api#documentation": "

Lambda couldn't decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.

", "smithy.api#error": "server", "smithy.api#httpError": 502 } @@ -7673,7 +8314,7 @@ } }, "traits": { - "smithy.api#documentation": "

Lambda couldn't decrypt the environment variables because the KMS key used is\n disabled. Check the Lambda function's KMS key settings.

", + "smithy.api#documentation": "

Lambda couldn't decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.

", "smithy.api#error": "server", "smithy.api#httpError": 502 } @@ -7711,7 +8352,7 @@ } }, "traits": { - "smithy.api#documentation": "

Lambda couldn't decrypt the environment variables because the KMS key was not\n found. Check the function's KMS key settings.

", + "smithy.api#documentation": "

Lambda couldn't decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.

", "smithy.api#error": "server", "smithy.api#httpError": 502 } @@ -7722,18 +8363,18 @@ "Type": { "target": "com.amazonaws.lambda#KafkaSchemaRegistryAuthType", "traits": { - "smithy.api#documentation": "

\n The type of authentication Lambda uses to access your schema registry.\n

" + "smithy.api#documentation": "

The type of authentication Lambda uses to access your schema registry.

" } }, "URI": { "target": "com.amazonaws.lambda#Arn", "traits": { - "smithy.api#documentation": "

\n The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.\n

" + "smithy.api#documentation": "

The URI of the secret (Secrets Manager secret ARN) to authenticate with your schema registry.

" } } }, "traits": { - "smithy.api#documentation": "

Specific access configuration settings that tell Lambda how to authenticate with your schema registry.

\n

If you're working with an Glue schema registry, don't provide authentication details in this object.\n Instead, ensure that your execution role has the required permissions for Lambda to access your cluster.

\n

If you're working with a Confluent schema registry, choose the authentication method in the Type field,\n and provide the Secrets Manager secret ARN in the URI field.

" + "smithy.api#documentation": "

Specific access configuration settings that tell Lambda how to authenticate with your schema registry.

If you're working with an Glue schema registry, don't provide authentication details in this object. Instead, ensure that your execution role has the required permissions for Lambda to access your cluster.

If you're working with a Confluent schema registry, choose the authentication method in the Type field, and provide the Secrets Manager secret ARN in the URI field.

" } }, "com.amazonaws.lambda#KafkaSchemaRegistryAccessConfigList": { @@ -7771,13 +8412,13 @@ "SchemaRegistryURI": { "target": "com.amazonaws.lambda#SchemaRegistryUri", "traits": { - "smithy.api#documentation": "

The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.

\n
    \n
  • \n

    For Glue schema registries, use the ARN of the registry.

    \n
    • \n
  • \n

    For Confluent schema registries, use the URL of the registry.

    \n
    • \n
" + "smithy.api#documentation": "

The URI for your schema registry. The correct URI format depends on the type of schema registry you're using.

  • For Glue schema registries, use the ARN of the registry.

  • For Confluent schema registries, use the URL of the registry.

" } }, "EventRecordFormat": { "target": "com.amazonaws.lambda#SchemaRegistryEventRecordFormat", "traits": { - "smithy.api#documentation": "

The record format that Lambda delivers to your function after schema validation.

\n
    \n
  • \n

    Choose JSON to have Lambda deliver the record to your function as a standard JSON object.

    \n
    • \n
  • \n

    Choose SOURCE to have Lambda deliver the record to your function in its original source format.\n Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.

    \n
    • \n
" + "smithy.api#documentation": "

The record format that Lambda delivers to your function after schema validation.

  • Choose JSON to have Lambda deliver the record to your function as a standard JSON object.

  • Choose SOURCE to have Lambda deliver the record to your function in its original source format. Lambda removes all schema metadata, such as the schema ID, before sending the record to your function.

" } }, "AccessConfigs": { @@ -7789,7 +8430,7 @@ "SchemaValidationConfigs": { "target": "com.amazonaws.lambda#KafkaSchemaValidationConfigList", "traits": { - "smithy.api#documentation": "

An array of schema validation configuration objects, which tell Lambda the message\n attributes you want to validate and filter using your schema registry.

" + "smithy.api#documentation": "

An array of schema validation configuration objects, which tell Lambda the message attributes you want to validate and filter using your schema registry.

" } } }, @@ -7820,12 +8461,12 @@ "Attribute": { "target": "com.amazonaws.lambda#KafkaSchemaValidationAttribute", "traits": { - "smithy.api#documentation": "

\n The attributes you want your schema registry to validate and filter for. If you selected JSON as the\n EventRecordFormat, Lambda also deserializes the selected message attributes.\n

" + "smithy.api#documentation": "

The attributes you want your schema registry to validate and filter for. If you selected JSON as the EventRecordFormat, Lambda also deserializes the selected message attributes.

" } } }, "traits": { - "smithy.api#documentation": "

Specific schema validation configuration settings that tell Lambda the message\n attributes you want to validate and filter using your schema registry.

" + "smithy.api#documentation": "

Specific schema validation configuration settings that tell Lambda the message attributes you want to validate and filter using your schema registry.

" } }, "com.amazonaws.lambda#KafkaSchemaValidationConfigList": { @@ -8016,12 +8657,12 @@ "SigningJobArn": { "target": "com.amazonaws.lambda#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a signing job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a signing job.

" } } }, "traits": { - "smithy.api#documentation": "

An Lambda\n layer.

" + "smithy.api#documentation": "

An Lambda layer.

" } }, "com.amazonaws.lambda#LayerArn": { @@ -8066,6 +8707,79 @@ "smithy.api#pattern": "^\\d{12}|\\*|arn:(aws[a-zA-Z-]*):iam::\\d{12}:root$" } }, + "com.amazonaws.lambda#LayerResource": { + "type": "resource", + "identifiers": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName" + } + }, + "list": { + "target": "com.amazonaws.lambda#ListLayers" + }, + "traits": { + "aws.api#arn": { + "template": "layer:{LayerName}" + }, + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "layer", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "Represents an AWS Lambda function layer" + } + }, + "com.amazonaws.lambda#LayerVersion": { + "type": "resource", + "identifiers": { + "LayerName": { + "target": "com.amazonaws.lambda#LayerName" + }, + "LayerVersion": { + "target": "com.amazonaws.lambda#String" + } + }, + "list": { + "target": "com.amazonaws.lambda#ListLayerVersions" + }, + "collectionOperations": [ + { + "target": "com.amazonaws.lambda#AddLayerVersionPermission" + }, + { + "target": "com.amazonaws.lambda#DeleteLayerVersion" + }, + { + "target": "com.amazonaws.lambda#GetLayerVersion" + }, + { + "target": "com.amazonaws.lambda#GetLayerVersionByArn" + }, + { + "target": "com.amazonaws.lambda#GetLayerVersionPolicy" + }, + { + "target": "com.amazonaws.lambda#PublishLayerVersion" + }, + { + "target": "com.amazonaws.lambda#RemoveLayerVersionPermission" + } + ], + "traits": { + "aws.api#arn": { + "template": "layer:{LayerName}:{LayerVersion}" + }, + "aws.iam#iamResource": { + "disableConditionKeyInheritance": true, + "name": "layerVersion", + "relativeDocumentation": "lambda-api-permissions-ref.html" + }, + "smithy.api#documentation": "Represents a version of an AWS Lambda function layer", + "smithy.api#suppress": [ + "IamResourceTrait" + ] + } + }, "com.amazonaws.lambda#LayerVersionArn": { "type": "string", "traits": { @@ -8100,12 +8814,12 @@ "ZipFile": { "target": "com.amazonaws.lambda#Blob", "traits": { - "smithy.api#documentation": "

The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for\n you.

" + "smithy.api#documentation": "

The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.

" } } }, "traits": { - "smithy.api#documentation": "

A ZIP archive that contains the contents of an Lambda\n layer. You can specify either an Amazon S3 location,\n or upload a layer archive directly.

" + "smithy.api#documentation": "

A ZIP archive that contains the contents of an Lambda layer. You can specify either an Amazon S3 location, or upload a layer archive directly.

" } }, "com.amazonaws.lambda#LayerVersionContentOutput": { @@ -8139,12 +8853,12 @@ "SigningJobArn": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a signing job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a signing job.

" } } }, "traits": { - "smithy.api#documentation": "

Details about a version of an Lambda\n layer.

" + "smithy.api#documentation": "

Details about a version of an Lambda layer.

" } }, "com.amazonaws.lambda#LayerVersionNumber": { @@ -8190,7 +8904,7 @@ "CompatibleRuntimes": { "target": "com.amazonaws.lambda#CompatibleRuntimes", "traits": { - "smithy.api#documentation": "

The layer's compatible runtimes.

\n

The following list includes deprecated runtimes. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

" + "smithy.api#documentation": "

The layer's compatible runtimes.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" } }, "LicenseInfo": { @@ -8202,12 +8916,12 @@ "CompatibleArchitectures": { "target": "com.amazonaws.lambda#CompatibleArchitectures", "traits": { - "smithy.api#documentation": "

A list of compatible \n instruction set architectures.

" + "smithy.api#documentation": "

A list of compatible instruction set architectures.

" } } }, "traits": { - "smithy.api#documentation": "

Details about a version of an Lambda\n layer.

" + "smithy.api#documentation": "

Details about a version of an Lambda layer.

" } }, "com.amazonaws.lambda#LayersList": { @@ -8239,7 +8953,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about an Lambda\n layer.

" + "smithy.api#documentation": "

Details about an Lambda layer.

" } }, "com.amazonaws.lambda#LayersReferenceList": { @@ -8280,7 +8994,16 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of aliases\n for a Lambda function.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of aliases for an AWS Lambda function", + "relativeDocumentation": "API_ListAliases.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Returns a list of aliases for a Lambda function.

", "smithy.api#examples": [ { "title": "To list a function's aliases", @@ -8319,11 +9042,9 @@ "code": 200 }, "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "Aliases", - "pageSize": "MaxItems" - } + "items": "Aliases" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#ListAliasesRequest": { @@ -8332,7 +9053,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8400,18 +9121,20 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of code\n signing configurations. A request returns up to 10,000 configurations per\n call. You can use the MaxItems parameter to return fewer configurations per call.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of AWS Lambda code signing configs", + "relativeDocumentation": "API_ListCodeSigningConfigs.html" + }, + "smithy.api#documentation": "

Returns a list of code signing configurations. A request returns up to 10,000 configurations per call. You can use the MaxItems parameter to return fewer configurations per call.

", "smithy.api#http": { "method": "GET", "uri": "/2020-04-22/code-signing-configs", "code": 200 }, "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "CodeSigningConfigs", - "pageSize": "MaxItems" - } + "items": "CodeSigningConfigs" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#ListCodeSigningConfigsRequest": { @@ -8479,7 +9202,11 @@ } ], "traits": { - "smithy.api#documentation": "

Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a\n single event source.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of AWS Lambda event source mappings", + "relativeDocumentation": "API_ListEventSourceMappings.html" + }, + "smithy.api#documentation": "

Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a single event source.

", "smithy.api#examples": [ { "title": "To list the event source mappings for a function", @@ -8508,11 +9235,9 @@ "code": 200 }, "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "EventSourceMappings", - "pageSize": "MaxItems" - } + "items": "EventSourceMappings" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#ListEventSourceMappingsRequest": { @@ -8521,14 +9246,14 @@ "EventSourceArn": { "target": "com.amazonaws.lambda#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

\n
    \n
  • \n

    \n Amazon Kinesis – The ARN of the data stream or a stream consumer.

    \n
    • \n
  • \n

    \n Amazon DynamoDB Streams – The ARN of the stream.

    \n
    • \n
  • \n

    \n Amazon Simple Queue Service – The ARN of the queue.

    \n
    • \n
  • \n

    \n Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

    \n
    • \n
  • \n

    \n Amazon MQ – The ARN of the broker.

    \n
    • \n
  • \n

    \n Amazon DocumentDB – The ARN of the DocumentDB change stream.

    \n
    • \n
", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event source.

  • Amazon Kinesis – The ARN of the data stream or a stream consumer.

  • Amazon DynamoDB Streams – The ARN of the stream.

  • Amazon Simple Queue Service – The ARN of the queue.

  • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

  • Amazon MQ – The ARN of the broker.

  • Amazon DocumentDB – The ARN of the DocumentDB change stream.

", "smithy.api#httpQuery": "EventSourceArn" } }, "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – MyFunction.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – MyFunction.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN – 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

", "smithy.api#httpQuery": "FunctionName" } }, @@ -8542,7 +9267,7 @@ "MaxItems": { "target": "com.amazonaws.lambda#MaxListItems", "traits": { - "smithy.api#documentation": "

The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of\n 100 items in each response, even if you set the number higher.

", + "smithy.api#documentation": "

The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of 100 items in each response, even if you set the number higher.

", "smithy.api#httpQuery": "MaxItems" } } @@ -8594,7 +9319,16 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of configurations for asynchronous invocation for a function.

\n

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of configurations for asynchronous invocation for a function", + "relativeDocumentation": "API_ListFunctionEventInvokeConfigs.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Retrieves a list of configurations for asynchronous invocation for a function.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", "smithy.api#examples": [ { "title": "To view a list of asynchronous invocation configurations", @@ -8626,11 +9360,9 @@ "code": 200 }, "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "FunctionEventInvokeConfigs", - "pageSize": "MaxItems" - } + "items": "FunctionEventInvokeConfigs" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#ListFunctionEventInvokeConfigsRequest": { @@ -8639,7 +9371,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - my-function.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name - my-function.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8706,6 +9438,18 @@ } ], "traits": { + "aws.iam#conditionKeys": [ + "lambda:FunctionUrlAuthType" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to read function url configurations for a function", + "relativeDocumentation": "API_ListFunctionUrlConfigs.html", + "resources": { + "required": { + "function": {} + } + } + }, "smithy.api#documentation": "

Returns a list of Lambda function URLs for the specified function.

", "smithy.api#http": { "method": "GET", @@ -8713,11 +9457,9 @@ "code": 200 }, "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "FunctionUrlConfigs", - "pageSize": "MaxItems" - } + "items": "FunctionUrlConfigs" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#ListFunctionUrlConfigsRequest": { @@ -8726,7 +9468,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8741,7 +9483,7 @@ "MaxItems": { "target": "com.amazonaws.lambda#MaxItems", "traits": { - "smithy.api#documentation": "

The maximum number of function URLs to return in the response. Note that ListFunctionUrlConfigs\n returns a maximum of 50 items in each response, even if you set the number higher.

", + "smithy.api#documentation": "

The maximum number of function URLs to return in the response. Note that ListFunctionUrlConfigs returns a maximum of 50 items in each response, even if you set the number higher.

", "smithy.api#httpQuery": "MaxItems" } } @@ -8791,7 +9533,11 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50\n functions per call.

\n

Set FunctionVersion to ALL to include all published versions of each function in\n addition to the unpublished version.

\n \n

The ListFunctions operation returns a subset of the FunctionConfiguration fields.\n To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason,\n LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use GetFunction.

\n ", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of AWS Lambda functions, with the version-specific configuration of each function", + "relativeDocumentation": "API_ListFunctions.html" + }, + "smithy.api#documentation": "

Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.

Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version.

The ListFunctions operation returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use GetFunction.

", "smithy.api#examples": [ { "title": "To get a list of Lambda functions", @@ -8850,11 +9596,20 @@ "code": 200 }, "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "Functions", - "pageSize": "MaxItems" - } + "items": "Functions" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "ListFunctionsSuccess", + "params": {}, + "expect": { + "success": {} + }, + "vendorParams": {}, + "vendorParamsShape": "aws.test#AwsVendorParams" + } + ] } }, "com.amazonaws.lambda#ListFunctionsByCodeSigningConfig": { @@ -8877,18 +9632,25 @@ } ], "traits": { - "smithy.api#documentation": "

List the functions that use the specified code signing configuration. You can use this method prior to deleting a\n code signing configuration, to verify that no functions are using it.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of AWS Lambda functions by the code signing config assigned ", + "relativeDocumentation": "API_ListFunctionsByCodeSigningConfig.html", + "resources": { + "required": { + "code signing config": {} + } + } + }, + "smithy.api#documentation": "

List the functions that use the specified code signing configuration. You can use this method prior to deleting a code signing configuration, to verify that no functions are using it.

", "smithy.api#http": { "method": "GET", "uri": "/2020-04-22/code-signing-configs/{CodeSigningConfigArn}/functions", "code": 200 }, "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "FunctionArns", - "pageSize": "MaxItems" - } + "items": "FunctionArns" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#ListFunctionsByCodeSigningConfigRequest": { @@ -8947,7 +9709,7 @@ "MasterRegion": { "target": "com.amazonaws.lambda#MasterRegion", "traits": { - "smithy.api#documentation": "

For Lambda@Edge functions, the Amazon Web Services Region of the master function. For example,\n us-east-1 filters the list of functions to include only Lambda@Edge functions replicated from a\n master function in US East (N. Virginia). If specified, you must set FunctionVersion to\n ALL.

", + "smithy.api#documentation": "

For Lambda@Edge functions, the Amazon Web Services Region of the master function. For example, us-east-1 filters the list of functions to include only Lambda@Edge functions replicated from a master function in US East (N. Virginia). If specified, you must set FunctionVersion to ALL.

", "smithy.api#httpQuery": "MasterRegion" } }, @@ -8968,7 +9730,7 @@ "MaxItems": { "target": "com.amazonaws.lambda#MaxListItems", "traits": { - "smithy.api#documentation": "

The maximum number of functions to return in the response. Note that ListFunctions returns a maximum of 50 items in each response,\n even if you set the number higher.

", + "smithy.api#documentation": "

The maximum number of functions to return in the response. Note that ListFunctions returns a maximum of 50 items in each response, even if you set the number higher.

", "smithy.api#httpQuery": "MaxItems" } } @@ -9021,7 +9783,11 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the versions of an Lambda\n layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only\n versions that indicate that they're compatible with that runtime. Specify a compatible architecture to include only \n layer versions that are compatible with that architecture.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of versions of an AWS Lambda layer", + "relativeDocumentation": "API_ListLayerVersions.html" + }, + "smithy.api#documentation": "

Lists the versions of an Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layer versions that are compatible with that architecture.

", "smithy.api#examples": [ { "title": "To list versions of a layer", @@ -9059,11 +9825,9 @@ "code": 200 }, "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "LayerVersions", - "pageSize": "MaxItems" - } + "items": "LayerVersions" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#ListLayerVersionsRequest": { @@ -9072,7 +9836,7 @@ "CompatibleRuntime": { "target": "com.amazonaws.lambda#Runtime", "traits": { - "smithy.api#documentation": "

A runtime identifier.

\n

The following list includes deprecated runtimes. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

", + "smithy.api#documentation": "

A runtime identifier.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

", "smithy.api#httpQuery": "CompatibleRuntime" } }, @@ -9101,7 +9865,7 @@ "CompatibleArchitecture": { "target": "com.amazonaws.lambda#Architecture", "traits": { - "smithy.api#documentation": "

The compatible \ninstruction set architecture.

", + "smithy.api#documentation": "

The compatible instruction set architecture.

", "smithy.api#httpQuery": "CompatibleArchitecture" } } @@ -9150,7 +9914,11 @@ } ], "traits": { - "smithy.api#documentation": "

Lists Lambda\n layers and shows information about the latest version of each. Specify a\n runtime\n identifier to list only layers that indicate that they're compatible with that\n runtime. Specify a compatible architecture to include only layers that are compatible with\n that instruction set architecture.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of AWS Lambda layers, with details about the latest version of each layer", + "relativeDocumentation": "API_ListLayers.html" + }, + "smithy.api#documentation": "

Lists Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layers that are compatible with that instruction set architecture.

", "smithy.api#examples": [ { "title": "To list the layers that are compatible with your function's runtime", @@ -9184,11 +9952,9 @@ "code": 200 }, "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "Layers", - "pageSize": "MaxItems" - } + "items": "Layers" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#ListLayersRequest": { @@ -9197,7 +9963,7 @@ "CompatibleRuntime": { "target": "com.amazonaws.lambda#Runtime", "traits": { - "smithy.api#documentation": "

A runtime identifier.

\n

The following list includes deprecated runtimes. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

", + "smithy.api#documentation": "

A runtime identifier.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

", "smithy.api#httpQuery": "CompatibleRuntime" } }, @@ -9218,7 +9984,7 @@ "CompatibleArchitecture": { "target": "com.amazonaws.lambda#Architecture", "traits": { - "smithy.api#documentation": "

The compatible \ninstruction set architecture.

", + "smithy.api#documentation": "

The compatible instruction set architecture.

", "smithy.api#httpQuery": "CompatibleArchitecture" } } @@ -9270,6 +10036,15 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of provisioned concurrency configurations for an AWS Lambda function", + "relativeDocumentation": "API_ListProvisionedConcurrencyConfigs.html", + "resources": { + "required": { + "function": {} + } + } + }, "smithy.api#documentation": "

Retrieves a list of provisioned concurrency configurations for a function.

", "smithy.api#examples": [ { @@ -9306,11 +10081,9 @@ "code": 200 }, "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "ProvisionedConcurrencyConfigs", - "pageSize": "MaxItems" - } + "items": "ProvisionedConcurrencyConfigs" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#ListProvisionedConcurrencyConfigsRequest": { @@ -9319,7 +10092,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9386,7 +10159,18 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a function, event source mapping, or code signing configuration's tags. You can\n also view function tags with GetFunction.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of tags for an AWS Lambda function, event source mapping or code signing configuration resource", + "relativeDocumentation": "API_ListTags.html", + "resources": { + "optional": { + "eventSourceMapping": {}, + "function": {}, + "code signing config": {} + } + } + }, + "smithy.api#documentation": "

Returns a function, event source mapping, or code signing configuration's tags. You can also view function tags with GetFunction.

", "smithy.api#examples": [ { "title": "To retrieve the list of tags for a Lambda function", @@ -9406,7 +10190,8 @@ "method": "GET", "uri": "/2017-03-31/tags/{Resource}", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#ListTagsRequest": { @@ -9415,7 +10200,7 @@ "Resource": { "target": "com.amazonaws.lambda#TaggableResource", "traits": { - "smithy.api#documentation": "

The resource's Amazon Resource Name (ARN). \n Note: Lambda does not support adding tags to function aliases or versions.

", + "smithy.api#documentation": "

The resource's Amazon Resource Name (ARN). Note: Lambda does not support adding tags to function aliases or versions.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9462,7 +10247,16 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of versions,\n with the version-specific configuration of each. Lambda returns up to 50 versions per call.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to retrieve a list of versions for an AWS Lambda function", + "relativeDocumentation": "API_ListVersionsByFunction.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call.

", "smithy.api#examples": [ { "title": "To list versions of a function", @@ -9532,11 +10326,9 @@ "code": 200 }, "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "Versions", - "pageSize": "MaxItems" - } + "items": "Versions" + }, + "smithy.api#readonly": {} } }, "com.amazonaws.lambda#ListVersionsByFunctionRequest": { @@ -9545,7 +10337,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#NamespacedFunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9560,7 +10352,7 @@ "MaxItems": { "target": "com.amazonaws.lambda#MaxListItems", "traits": { - "smithy.api#documentation": "

The maximum number of versions to return. Note that ListVersionsByFunction returns a maximum of 50 items in each response, \n even if you set the number higher.

", + "smithy.api#documentation": "

The maximum number of versions to return. Note that ListVersionsByFunction returns a maximum of 50 items in each response, even if you set the number higher.

", "smithy.api#httpQuery": "MaxItems" } } @@ -9649,25 +10441,25 @@ "LogFormat": { "target": "com.amazonaws.lambda#LogFormat", "traits": { - "smithy.api#documentation": "

The format in which Lambda sends your function's application and system logs to CloudWatch. Select between \n plain text and structured JSON.

" + "smithy.api#documentation": "

The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.

" } }, "ApplicationLogLevel": { "target": "com.amazonaws.lambda#ApplicationLogLevel", "traits": { - "smithy.api#documentation": "

Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the \n selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.

" + "smithy.api#documentation": "

Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where TRACE is the highest level and FATAL is the lowest.

" } }, "SystemLogLevel": { "target": "com.amazonaws.lambda#SystemLogLevel", "traits": { - "smithy.api#documentation": "

Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the \n selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

" + "smithy.api#documentation": "

Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where DEBUG is the highest level and WARN is the lowest.

" } }, "LogGroup": { "target": "com.amazonaws.lambda#LogGroup", "traits": { - "smithy.api#documentation": "

The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default \n log group named /aws/lambda/. To use a different log group, enter an existing log group or enter a new log group name.

" + "smithy.api#documentation": "

The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named /aws/lambda/<function name>. To use a different log group, enter an existing log group or enter a new log group name.

" } } }, @@ -9875,7 +10667,7 @@ "Destination": { "target": "com.amazonaws.lambda#DestinationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination resource.

\n

To retain records of unsuccessful asynchronous invocations,\n you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function,\n or Amazon EventBridge event bus as the destination.

\n

To retain records of failed invocations from Kinesis, \n DynamoDB, self-managed Kafka or\n Amazon MSK,\n you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination resource.

To retain records of unsuccessful asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function, or Amazon EventBridge event bus as the destination.

To retain records of failed invocations from Kinesis, DynamoDB, self-managed Kafka or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.

" } } }, @@ -9894,7 +10686,7 @@ } }, "traits": { - "smithy.api#documentation": "

A destination for events that were processed successfully.

\n

To retain records of successful asynchronous invocations,\n you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function,\n or Amazon EventBridge event bus as the destination.

\n \n

\n OnSuccess is not supported in CreateEventSourceMapping or UpdateEventSourceMapping requests.

\n " + "smithy.api#documentation": "

A destination for events that were processed successfully.

To retain records of successful asynchronous invocations, you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.

OnSuccess is not supported in CreateEventSourceMapping or UpdateEventSourceMapping requests.

" } }, "com.amazonaws.lambda#OrganizationId": { @@ -9953,6 +10745,27 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.lambda#Permission": { + "type": "resource", + "identifiers": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName" + }, + "StatementId": { + "target": "com.amazonaws.lambda#StatementId" + } + }, + "operations": [ + { + "target": "com.amazonaws.lambda#AddPermission" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.lambda#RemovePermission" + } + ] + }, "com.amazonaws.lambda#PolicyLengthExceededException": { "type": "structure", "members": { @@ -9994,7 +10807,7 @@ } }, "traits": { - "smithy.api#documentation": "

The RevisionId provided does not match the latest RevisionId for the Lambda function or alias.

\n
    \n
  • \n

    \n For AddPermission and RemovePermission API operations: Call GetPolicy to retrieve the latest RevisionId for your resource.

    \n
    • \n
  • \n

    \n For all other API operations: Call GetFunction or GetAlias to retrieve the latest RevisionId for your resource.

    \n
    • \n
", + "smithy.api#documentation": "

The RevisionId provided does not match the latest RevisionId for the Lambda function or alias.

  • For AddPermission and RemovePermission API operations: Call GetPolicy to retrieve the latest RevisionId for your resource.

  • For all other API operations: Call GetFunction or GetAlias to retrieve the latest RevisionId for your resource.

", "smithy.api#error": "client", "smithy.api#httpError": 412 } @@ -10015,6 +10828,26 @@ "smithy.api#pattern": "^o-[a-z0-9]{10,32}$" } }, + "com.amazonaws.lambda#ProvisionedConcurrencyConfig": { + "type": "resource", + "identifiers": { + "FunctionName": { + "target": "com.amazonaws.lambda#FunctionName" + }, + "Qualifier": { + "target": "com.amazonaws.lambda#Qualifier" + } + }, + "put": { + "target": "com.amazonaws.lambda#PutProvisionedConcurrencyConfig" + }, + "read": { + "target": "com.amazonaws.lambda#GetProvisionedConcurrencyConfig" + }, + "delete": { + "target": "com.amazonaws.lambda#DeleteProvisionedConcurrencyConfig" + } + }, "com.amazonaws.lambda#ProvisionedConcurrencyConfigList": { "type": "list", "member": { @@ -10127,7 +10960,7 @@ } }, "traits": { - "smithy.api#documentation": "

The \n provisioned mode configuration for the event source. Use Provisioned Mode to customize the minimum and maximum number of event pollers\n for your event source. An event poller is a compute unit that provides approximately 5 MBps of throughput.

" + "smithy.api#documentation": "

The provisioned mode configuration for the event source. Use Provisioned Mode to customize the minimum and maximum number of event pollers for your event source. An event poller is a compute unit that provides approximately 5 MBps of throughput.

" } }, "com.amazonaws.lambda#PublishLayerVersion": { @@ -10156,7 +10989,19 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Lambda\n layer from a ZIP archive. Each time you call PublishLayerVersion with the same\n layer name, a new version is created.

\n

Add layers to your function with CreateFunction or UpdateFunctionConfiguration.

", + "aws.iam#iamAction": { + "createsResources": [ + "layerVersion" + ], + "documentation": "Grants permission to create an AWS Lambda layer", + "relativeDocumentation": "API_PublishLayerVersion.html", + "resources": { + "required": { + "layer": {} + } + } + }, + "smithy.api#documentation": "

Creates an Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created.

Add layers to your function with CreateFunction or UpdateFunctionConfiguration.

", "smithy.api#examples": [ { "title": "To create a Lambda layer version", @@ -10227,19 +11072,19 @@ "CompatibleRuntimes": { "target": "com.amazonaws.lambda#CompatibleRuntimes", "traits": { - "smithy.api#documentation": "

A list of compatible function\n runtimes. Used for filtering with ListLayers and ListLayerVersions.

\n

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

" + "smithy.api#documentation": "

A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

" } }, "LicenseInfo": { "target": "com.amazonaws.lambda#LicenseInfo", "traits": { - "smithy.api#documentation": "

The layer's software license. It can be any of the following:

\n
    \n
  • \n

    An SPDX license identifier. For example,\n MIT.

    \n
    • \n
  • \n

    The URL of a license hosted on the internet. For example,\n https://opensource.org/licenses/MIT.

    \n
    • \n
  • \n

    The full text of the license.

    \n
    • \n
" + "smithy.api#documentation": "

The layer's software license. It can be any of the following:

  • An SPDX license identifier. For example, MIT.

  • The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT.

  • The full text of the license.

" } }, "CompatibleArchitectures": { "target": "com.amazonaws.lambda#CompatibleArchitectures", "traits": { - "smithy.api#documentation": "

A list of compatible \ninstruction set architectures.

" + "smithy.api#documentation": "

A list of compatible instruction set architectures.

" } } }, @@ -10290,7 +11135,7 @@ "CompatibleRuntimes": { "target": "com.amazonaws.lambda#CompatibleRuntimes", "traits": { - "smithy.api#documentation": "

The layer's compatible runtimes.

\n

The following list includes deprecated runtimes. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

" + "smithy.api#documentation": "

The layer's compatible runtimes.

The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" } }, "LicenseInfo": { @@ -10302,7 +11147,7 @@ "CompatibleArchitectures": { "target": "com.amazonaws.lambda#CompatibleArchitectures", "traits": { - "smithy.api#documentation": "

A list of compatible \ninstruction set architectures.

" + "smithy.api#documentation": "

A list of compatible instruction set architectures.

" } } }, @@ -10342,7 +11187,16 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a version from the\n current code and configuration of a function. Use versions to create a snapshot of your function code and\n configuration that doesn't change.

\n

Lambda doesn't publish a version if the function's configuration and code haven't changed since the last\n version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the\n function before publishing a version.

\n

Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to create an AWS Lambda function version", + "relativeDocumentation": "API_PublishVersion.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.

Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version.

Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.

", "smithy.api#examples": [ { "title": "To publish a version of a Lambda function", @@ -10394,7 +11248,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10402,7 +11256,7 @@ "CodeSha256": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

Only publish a version if the hash value matches the value that's specified. Use this option to avoid\n publishing a version if the function code has changed since you last updated it. You can get the hash for the\n version that you uploaded from the output of UpdateFunctionCode.

" + "smithy.api#documentation": "

Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version that you uploaded from the output of UpdateFunctionCode.

" } }, "Description": { @@ -10414,7 +11268,7 @@ "RevisionId": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

Only update the function if the revision ID matches the ID that's specified. Use this option to avoid\n publishing a version if the function configuration has changed since you last updated it.

" + "smithy.api#documentation": "

Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it.

" } } }, @@ -10451,7 +11305,20 @@ } ], "traits": { - "smithy.api#documentation": "

Update the code signing configuration for the function. Changes to the code signing configuration take effect the\n next time a user tries to deploy a code package to the function.

", + "aws.iam#conditionKeys": [ + "lambda:CodeSigningConfigArn" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to attach a code signing config to an AWS Lambda function", + "relativeDocumentation": "API_PutFunctionCodeSigningConfig.html", + "resources": { + "required": { + "function": {}, + "code signing config": {} + } + } + }, + "smithy.api#documentation": "

Update the code signing configuration for the function. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.

", "smithy.api#http": { "method": "PUT", "uri": "/2020-06-30/functions/{FunctionName}/code-signing-config", @@ -10472,7 +11339,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10495,7 +11362,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#required": {} } } @@ -10530,7 +11397,16 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency\n level.

\n

Concurrency settings apply to the function as a whole, including all published versions and the unpublished\n version. Reserving concurrency both ensures that your function has capacity to process the specified number of\n events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see\n the current setting for a function.

\n

Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency\n for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for\n functions that aren't configured with a per-function limit. For more information, see Lambda function scaling.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to configure reserved concurrency for an AWS Lambda function", + "relativeDocumentation": "API_PutFunctionConcurrency.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.

Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function.

Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Lambda function scaling.

", "smithy.api#examples": [ { "title": "To configure a reserved concurrency limit for a function", @@ -10557,7 +11433,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10600,7 +11476,16 @@ } ], "traits": { - "smithy.api#documentation": "

Configures options for asynchronous\n invocation on a function, version, or alias. If a configuration already exists for a function, version,\n or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without\n affecting existing settings for other options, use UpdateFunctionEventInvokeConfig.

\n

By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains\n events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous\n invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with\n UpdateFunctionConfiguration.

\n

To send an invocation record to a queue, topic, S3 bucket, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events\n that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a\n dead-letter queue.

\n \n

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

\n ", + "aws.iam#iamAction": { + "documentation": "Grants permission to configures options for asynchronous invocation on an AWS Lambda function, version, or alias", + "relativeDocumentation": "API_PutFunctionEventInvokeConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use UpdateFunctionEventInvokeConfig.

By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with UpdateFunctionConfiguration.

To send an invocation record to a queue, topic, S3 bucket, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

", "smithy.api#examples": [ { "title": "To configure error handling for asynchronous invocation", @@ -10635,7 +11520,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10662,7 +11547,7 @@ "DestinationConfig": { "target": "com.amazonaws.lambda#DestinationConfig", "traits": { - "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

\n

\n Destinations\n

\n
    \n
  • \n

    \n Function - The Amazon Resource Name (ARN) of a Lambda function.

    \n
    • \n
  • \n

    \n Queue - The ARN of a standard SQS queue.

    \n
    • \n
  • \n

    \n Bucket - The ARN of an Amazon S3 bucket.

    \n
    • \n
  • \n

    \n Topic - The ARN of a standard SNS topic.

    \n
    • \n
  • \n

    \n Event Bus - The ARN of an Amazon EventBridge event bus.

    \n
    • \n
\n \n

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

\n " + "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

Destinations

  • Function - The Amazon Resource Name (ARN) of a Lambda function.

  • Queue - The ARN of a standard SQS queue.

  • Bucket - The ARN of an Amazon S3 bucket.

  • Topic - The ARN of a standard SNS topic.

  • Event Bus - The ARN of an Amazon EventBridge event bus.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

" } } }, @@ -10696,7 +11581,16 @@ } ], "traits": { - "smithy.api#documentation": "

Sets your function's recursive loop detection configuration.

\n

When you configure a Lambda function to output to the same service or resource that invokes the function, it's possible to create \n an infinite recursive loop. For example, a Lambda function might write a message to an Amazon Simple Queue Service (Amazon SQS) queue, which then invokes the same \n function. This invocation causes the function to write another message to the queue, which in turn invokes the function again.

\n

Lambda can detect certain types of recursive loops shortly after they occur. When Lambda detects a recursive loop and your \n function's recursive loop detection configuration is set to Terminate, it stops your function being invoked and notifies\n you.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to update the recursion configuration of an AWS Lambda function", + "relativeDocumentation": "API_PutFunctionRecursionConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Sets your function's recursive loop detection configuration.

When you configure a Lambda function to output to the same service or resource that invokes the function, it's possible to create an infinite recursive loop. For example, a Lambda function might write a message to an Amazon Simple Queue Service (Amazon SQS) queue, which then invokes the same function. This invocation causes the function to write another message to the queue, which in turn invokes the function again.

Lambda can detect certain types of recursive loops shortly after they occur. When Lambda detects a recursive loop and your function's recursive loop detection configuration is set to Terminate, it stops your function being invoked and notifies you.

", "smithy.api#http": { "method": "PUT", "uri": "/2024-08-31/functions/{FunctionName}/recursion-config", @@ -10710,7 +11604,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#UnqualifiedFunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10718,7 +11612,7 @@ "RecursiveLoop": { "target": "com.amazonaws.lambda#RecursiveLoop", "traits": { - "smithy.api#documentation": "

If you set your function's recursive loop detection configuration to Allow, Lambda doesn't take any action when it \n detects your function being invoked as part of a recursive loop. We recommend that you only use this setting if your design intentionally uses a \n Lambda function to write data back to the same Amazon Web Services resource that invokes it.

\n

If you set your function's recursive loop detection configuration to Terminate, Lambda stops your function being \n invoked and notifies you when it detects your function being invoked as part of a recursive loop.

\n

By default, Lambda sets your function's configuration to Terminate.

\n \n

If your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes\n the function, then use caution and implement suitable guard rails to prevent unexpected charges being billed to\n your Amazon Web Services account. To learn more about best practices for using recursive invocation patterns, see Recursive patterns that cause\n run-away Lambda functions in Serverless Land.

\n ", + "smithy.api#documentation": "

If you set your function's recursive loop detection configuration to Allow, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop. We recommend that you only use this setting if your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes it.

If you set your function's recursive loop detection configuration to Terminate, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.

By default, Lambda sets your function's configuration to Terminate.

If your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes the function, then use caution and implement suitable guard rails to prevent unexpected charges being billed to your Amazon Web Services account. To learn more about best practices for using recursive invocation patterns, see Recursive patterns that cause run-away Lambda functions in Serverless Land.

", "smithy.api#required": {} } } @@ -10733,7 +11627,7 @@ "RecursiveLoop": { "target": "com.amazonaws.lambda#RecursiveLoop", "traits": { - "smithy.api#documentation": "

The status of your function's recursive loop detection configuration.

\n

When this value is set to Allowand Lambda detects your function being invoked as part of a recursive \n loop, it doesn't take any action.

\n

When this value is set to Terminate and Lambda detects your function being invoked as part of a recursive \n loop, it stops your function being invoked and notifies you.\n

" + "smithy.api#documentation": "

The status of your function's recursive loop detection configuration.

When this value is set to Allowand Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action.

When this value is set to Terminate and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.

" } } }, @@ -10767,6 +11661,16 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to configure provisioned concurrency for an AWS Lambda function's alias or version", + "relativeDocumentation": "API_PutProvisionedConcurrencyConfig.html", + "resources": { + "optional": { + "function version": {}, + "function alias": {} + } + } + }, "smithy.api#documentation": "

Adds a provisioned concurrency configuration to a function's alias or version.

", "smithy.api#examples": [ { @@ -10789,7 +11693,8 @@ "method": "PUT", "uri": "/2019-09-30/functions/{FunctionName}/provisioned-concurrency", "code": 202 - } + }, + "smithy.api#idempotent": {} } }, "com.amazonaws.lambda#PutProvisionedConcurrencyConfigRequest": { @@ -10798,7 +11703,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10893,7 +11798,16 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the runtime management configuration for a function's version. For more information, \n see Runtime updates.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to update the runtime management configuration of an AWS Lambda function", + "relativeDocumentation": "API_PutRuntimeManagementConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Sets the runtime management configuration for a function's version. For more information, see Runtime updates.

", "smithy.api#http": { "method": "PUT", "uri": "/2021-07-20/functions/{FunctionName}/runtime-management-config", @@ -10907,7 +11821,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10915,21 +11829,21 @@ "Qualifier": { "target": "com.amazonaws.lambda#Qualifier", "traits": { - "smithy.api#documentation": "

Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the \n $LATEST version is returned.

", + "smithy.api#documentation": "

Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.

", "smithy.api#httpQuery": "Qualifier" } }, "UpdateRuntimeOn": { "target": "com.amazonaws.lambda#UpdateRuntimeOn", "traits": { - "smithy.api#documentation": "

Specify the runtime update mode.

\n
    \n
  • \n

    \n Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best \n choice for most customers to ensure they always benefit from runtime updates.

    \n
    • \n
  • \n

    \n Function update - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your \n function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and \n mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.

    \n
    • \n
  • \n

    \n Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. \n In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, \n see Roll back a runtime version.

    \n
    • \n
", + "smithy.api#documentation": "

Specify the runtime update mode.

  • Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.

  • Function update - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.

  • Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.

", "smithy.api#required": {} } }, "RuntimeVersionArn": { "target": "com.amazonaws.lambda#RuntimeVersionArn", "traits": { - "smithy.api#documentation": "

The ARN of the runtime version you want the function to use.

\n \n

This is only required if you're using the Manual runtime update mode.

\n " + "smithy.api#documentation": "

The ARN of the runtime version you want the function to use.

This is only required if you're using the Manual runtime update mode.

" } } }, @@ -10957,7 +11871,7 @@ "RuntimeVersionArn": { "target": "com.amazonaws.lambda#RuntimeVersionArn", "traits": { - "smithy.api#documentation": "

The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null \n is returned.

" + "smithy.api#documentation": "

The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwise null is returned.

" } } }, @@ -11062,7 +11976,16 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a statement from the permissions policy for a version of an Lambda\n layer. For more information, see\n AddLayerVersionPermission.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to remove a statement from the permissions policy for a version of an AWS Lambda layer", + "relativeDocumentation": "API_RemoveLayerVersionPermission.html", + "resources": { + "required": { + "layerVersion": {} + } + } + }, + "smithy.api#documentation": "

Removes a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.

", "smithy.api#examples": [ { "title": "To delete layer-version permissions", @@ -11112,12 +12035,13 @@ "RevisionId": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

", + "smithy.api#documentation": "

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.

", "smithy.api#httpQuery": "RevisionId" } } }, "traits": { + "aws.api#data": "permissions", "smithy.api#input": {} } }, @@ -11147,7 +12071,20 @@ } ], "traits": { - "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.

", + "aws.iam#conditionKeys": [ + "lambda:FunctionUrlAuthType", + "lambda:Principal" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to revoke function-use permission from an AWS service or another account", + "relativeDocumentation": "API_RemovePermission.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Revokes function-use permission from an Amazon Web Services service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy.

", "smithy.api#examples": [ { "title": "To remove a Lambda function's permissions", @@ -11172,7 +12109,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name – my-function (name-only), my-function:v1 (with alias).

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11195,12 +12132,13 @@ "RevisionId": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n policy that has changed since you last read it.

", + "smithy.api#documentation": "

Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

", "smithy.api#httpQuery": "RevisionId" } } }, "traits": { + "aws.api#data": "permissions", "smithy.api#input": {} } }, @@ -11215,7 +12153,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request payload exceeded the Invoke request body JSON input quota. For more information, see Lambda\n quotas.

", + "smithy.api#documentation": "

The request payload exceeded the Invoke request body JSON input quota. For more information, see Lambda quotas.

", "smithy.api#error": "client", "smithy.api#httpError": 413 } @@ -11267,7 +12205,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation conflicts with the resource's availability. For example, you tried to update an event source\n mapping in the CREATING state, or you tried to delete an event source mapping currently UPDATING.

", + "smithy.api#documentation": "

The operation conflicts with the resource's availability. For example, you tried to update an event source mapping in the CREATING state, or you tried to delete an event source mapping currently UPDATING.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11305,11 +12243,19 @@ } }, "traits": { - "smithy.api#documentation": "

The function is inactive and its VPC connection is no longer available. Wait for the VPC connection to\n reestablish and try again.

", + "smithy.api#documentation": "

The function is inactive and its VPC connection is no longer available. Wait for the VPC connection to reestablish and try again.

", "smithy.api#error": "server", "smithy.api#httpError": 502 } }, + "com.amazonaws.lambda#ResourcePolicy": { + "type": "resource", + "identifiers": { + "TargetArn": { + "target": "com.amazonaws.lambda#ResourceArn" + } + } + }, "com.amazonaws.lambda#ResponseStreamingInvocationType": { "type": "enum", "members": { @@ -11724,7 +12670,7 @@ "Endpoints": { "target": "com.amazonaws.lambda#Endpoints", "traits": { - "smithy.api#documentation": "

The list of bootstrap servers for your Kafka brokers in the following format: \"KAFKA_BOOTSTRAP_SERVERS\":\n [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"].

" + "smithy.api#documentation": "

The list of bootstrap servers for your Kafka brokers in the following format: \"KAFKA_BOOTSTRAP_SERVERS\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"].

" } } }, @@ -11738,7 +12684,7 @@ "ConsumerGroupId": { "target": "com.amazonaws.lambda#URI", "traits": { - "smithy.api#documentation": "

The identifier for the Kafka consumer group to join. The consumer group ID must be unique\n among all your Kafka event sources. After creating a Kafka event source mapping with the\n consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

" + "smithy.api#documentation": "

The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

" } }, "SchemaRegistryConfig": { @@ -11797,7 +12743,7 @@ } }, "traits": { - "smithy.api#documentation": "

The function's Lambda SnapStart setting. Set ApplyOn to PublishedVersions to create a\n snapshot of the initialized execution environment when you publish a function version.

" + "smithy.api#documentation": "

The function's Lambda SnapStart setting. Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.

" } }, "com.amazonaws.lambda#SnapStartApplyOn": { @@ -11828,7 +12774,7 @@ } }, "traits": { - "smithy.api#documentation": "

The afterRestore()\n runtime hook encountered an error. For more information, check the Amazon CloudWatch logs.

", + "smithy.api#documentation": "

The afterRestore() runtime hook encountered an error. For more information, check the Amazon CloudWatch logs.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -11908,7 +12854,7 @@ "Type": { "target": "com.amazonaws.lambda#SourceAccessType", "traits": { - "smithy.api#documentation": "

The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".

\n
    \n
  • \n

    \n BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.

    \n
    • \n
  • \n

    \n BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.

    \n
    • \n
  • \n

    \n VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.

    \n
    • \n
  • \n

    \n VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.

    \n
    • \n
  • \n

    \n SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.

    \n
    • \n
  • \n

    \n SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.

    \n
    • \n
  • \n

    \n VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. \n This property cannot be specified in an UpdateEventSourceMapping API call.

    \n
    • \n
  • \n

    \n CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), \n private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.

    \n
    • \n
  • \n

    \n SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.\n

    \n
    • \n
" + "smithy.api#documentation": "

The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".

  • BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.

  • BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.

  • VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.

  • VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.

  • SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.

  • SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.

  • VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.

  • CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.

  • SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.

" } }, "URI": { @@ -12214,7 +13160,7 @@ } }, "traits": { - "smithy.api#documentation": "

Lambda couldn't set up VPC access for the Lambda function because one or more\n configured subnets has no available IP addresses.

", + "smithy.api#documentation": "

Lambda couldn't set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.

", "smithy.api#error": "server", "smithy.api#httpError": 502 } @@ -12292,6 +13238,21 @@ } ], "traits": { + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to add tags to an AWS Lambda function, event source mapping or code signing configuration resource", + "relativeDocumentation": "API_TagResources.html", + "resources": { + "optional": { + "eventSourceMapping": {}, + "function": {}, + "code signing config": {} + } + } + }, "smithy.api#documentation": "

Adds tags to a function, event source mapping, or code signing configuration.

", "smithy.api#examples": [ { @@ -12510,7 +13471,7 @@ } }, "traits": { - "smithy.api#documentation": "

The function's X-Ray tracing configuration.\n To sample and record incoming requests, set Mode to Active.

" + "smithy.api#documentation": "

The function's X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active.

" } }, "com.amazonaws.lambda#TracingConfigResponse": { @@ -12623,6 +13584,20 @@ } ], "traits": { + "aws.iam#conditionKeys": [ + "aws:TagKeys" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to remove tags from an AWS Lambda function, event source mapping or code signing configuration resource", + "relativeDocumentation": "API_UntagResource.html", + "resources": { + "optional": { + "eventSourceMapping": {}, + "function": {}, + "code signing config": {} + } + } + }, "smithy.api#documentation": "

Removes tags from a function, event source mapping, or code signing configuration.

", "smithy.api#examples": [ { @@ -12696,6 +13671,15 @@ } ], "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update the configuration of an AWS Lambda function's alias", + "relativeDocumentation": "API_UpdateAlias.html", + "resources": { + "required": { + "function": {} + } + } + }, "smithy.api#documentation": "

Updates the configuration of a Lambda function alias.

", "smithy.api#examples": [ { @@ -12738,7 +13722,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - MyFunction.

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12748,7 +13732,8 @@ "traits": { "smithy.api#documentation": "

The name of the alias.

", "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "Alias" } }, "FunctionVersion": { @@ -12766,13 +13751,13 @@ "RoutingConfig": { "target": "com.amazonaws.lambda#AliasRoutingConfiguration", "traits": { - "smithy.api#documentation": "

The routing\n configuration of the alias.

" + "smithy.api#documentation": "

The routing configuration of the alias.

" } }, "RevisionId": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying\n an alias that has changed since you last read it.

" + "smithy.api#documentation": "

Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying an alias that has changed since you last read it.

" } } }, @@ -12800,7 +13785,16 @@ } ], "traits": { - "smithy.api#documentation": "

Update the code signing configuration. Changes to the code signing configuration take effect the next time a\n user tries to deploy a code package to the function.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to update an AWS Lambda code signing config", + "relativeDocumentation": "API_UpdateCodeSigningConfig.html", + "resources": { + "required": { + "code signing config": {} + } + } + }, + "smithy.api#documentation": "

Update the code signing configuration. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.

", "smithy.api#http": { "method": "PUT", "uri": "/2020-04-22/code-signing-configs/{CodeSigningConfigArn}", @@ -12886,7 +13880,19 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an event source mapping. You can change the function that Lambda invokes, or pause\n invocation and resume later from the same location.

\n

For details about how to configure different event sources, see the following topics.

\n \n

The following error handling options are available only for DynamoDB and Kinesis event sources:

\n
    \n
  • \n

    \n BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

    \n
    • \n
  • \n

    \n MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

    \n
    • \n
  • \n

    \n MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

    \n
    • \n
  • \n

    \n ParallelizationFactor – Process multiple batches from each shard concurrently.

    \n
    • \n
\n

For stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka), the following option is also available:

\n
    \n
  • \n

    \n OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, or \n Amazon S3 bucket. For more information, see Adding a destination.

    \n
    • \n
\n

For information about which configuration parameters apply to each event source, see the following topics.

\n ", + "aws.iam#conditionKeys": [ + "lambda:FunctionArn" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to update the configuration of an AWS Lambda event source mapping", + "relativeDocumentation": "API_UpdateEventSourceMapping.html", + "resources": { + "required": { + "eventSourceMapping": {} + } + } + }, + "smithy.api#documentation": "

Updates an event source mapping. You can change the function that Lambda invokes, or pause invocation and resume later from the same location.

For details about how to configure different event sources, see the following topics.

The following error handling options are available only for DynamoDB and Kinesis event sources:

  • BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

  • MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

  • MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

  • ParallelizationFactor – Process multiple batches from each shard concurrently.

For stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka), the following option is also available:

  • OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, or Amazon S3 bucket. For more information, see Adding a destination.

For information about which configuration parameters apply to each event source, see the following topics.

", "smithy.api#examples": [ { "title": "To update a Lambda function event source mapping", @@ -12930,31 +13936,31 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – MyFunction.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    \n
    • \n
  • \n

    \n Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:MyFunction.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64\n characters in length.

" + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – MyFunction.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN – 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

" } }, "Enabled": { "target": "com.amazonaws.lambda#Enabled", "traits": { - "smithy.api#documentation": "

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

\n

Default: True

" + "smithy.api#documentation": "

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

Default: True

" } }, "BatchSize": { "target": "com.amazonaws.lambda#BatchSize", "traits": { - "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).

\n
    \n
  • \n

    \n Amazon Kinesis – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Amazon DynamoDB Streams – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

    \n
    • \n
  • \n

    \n Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Self-managed Apache Kafka – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

    \n
    • \n
  • \n

    \n DocumentDB – Default 100. Max 10,000.

    \n
    • \n
" + "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

  • Amazon Kinesis – Default 100. Max 10,000.

  • Amazon DynamoDB Streams – Default 100. Max 10,000.

  • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

  • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

  • Self-managed Apache Kafka – Default 100. Max 10,000.

  • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

  • DocumentDB – Default 100. Max 10,000.

" } }, "FilterCriteria": { "target": "com.amazonaws.lambda#FilterCriteria", "traits": { - "smithy.api#documentation": "

An object that defines the filter criteria that\n determine whether Lambda should process an event. For more information, see Lambda event filtering.

" + "smithy.api#documentation": "

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

" } }, "MaximumBatchingWindowInSeconds": { "target": "com.amazonaws.lambda#MaximumBatchingWindowInSeconds", "traits": { - "smithy.api#documentation": "

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.\n You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

\n

For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default\n batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.\n To restore the default batching window, you must create a new event source mapping.

\n

Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" + "smithy.api#documentation": "

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

" } }, "DestinationConfig": { @@ -13026,7 +14032,7 @@ "KMSKeyArn": { "target": "com.amazonaws.lambda#KMSKeyArn", "traits": { - "smithy.api#documentation": "

\n The ARN of the Key Management Service (KMS) customer managed key that Lambda\n uses to encrypt your function's filter criteria.\n By default, Lambda does not encrypt your filter criteria object. Specify this\n property to encrypt data using your own customer managed key.\n

" + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

" } }, "MetricsConfig": { @@ -13038,7 +14044,7 @@ "ProvisionedPollerConfig": { "target": "com.amazonaws.lambda#ProvisionedPollerConfig", "traits": { - "smithy.api#documentation": "

(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source.\n For more information, see provisioned mode.

" + "smithy.api#documentation": "

(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

" } } }, @@ -13087,7 +14093,16 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a Lambda function's code. If code signing is enabled for the function, the code package\n must be signed by a trusted publisher. For more information, see Configuring code signing for Lambda.

\n

If the function's package type is Image, then you must specify the code package in\n ImageUri as the URI of a container image in the Amazon ECR registry.

\n

If the function's package type is Zip, then you must specify the deployment package as a .zip file\n archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide\n the function code inline using the ZipFile field.

\n

The code in the deployment package must be compatible with the target instruction set architecture of the\n function (x86-64 or arm64).

\n

The function's code is locked when you publish a version. You can't modify the code of a published version,\n only the unpublished version.

\n \n

For a function defined as a container image, Lambda resolves the image tag to an image digest. In\n Amazon ECR, if you update the image tag to a new image, Lambda does not automatically\n update the function.

\n ", + "aws.iam#iamAction": { + "documentation": "Grants permission to update the code of an AWS Lambda function", + "relativeDocumentation": "API_UpdateFunctionCode.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing for Lambda.

If the function's package type is Image, then you must specify the code package in ImageUri as the URI of a container image in the Amazon ECR registry.

If the function's package type is Zip, then you must specify the deployment package as a .zip file archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide the function code inline using the ZipFile field.

The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64).

The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.

For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.

", "smithy.api#examples": [ { "title": "To update a Lambda function's code", @@ -13121,7 +14136,10 @@ "method": "PUT", "uri": "/2015-03-31/functions/{FunctionName}/code", "code": 200 - } + }, + "smithy.api#suppress": [ + "DefaultValueInUpdate" + ] } }, "com.amazonaws.lambda#UpdateFunctionCodeRequest": { @@ -13130,7 +14148,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13138,13 +14156,13 @@ "ZipFile": { "target": "com.amazonaws.lambda#Blob", "traits": { - "smithy.api#documentation": "

The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients \nhandle the encoding for you. Use only with a function defined with a .zip file archive deployment package.

" + "smithy.api#documentation": "

The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you. Use only with a function defined with a .zip file archive deployment package.

" } }, "S3Bucket": { "target": "com.amazonaws.lambda#S3Bucket", "traits": { - "smithy.api#documentation": "

An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different \nAmazon Web Services account. Use only with a function defined with a .zip file archive deployment package.

" + "smithy.api#documentation": "

An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.

" } }, "S3Key": { @@ -13162,39 +14180,39 @@ "ImageUri": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip\n file archive.

" + "smithy.api#documentation": "

URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.

" } }, "Publish": { "target": "com.amazonaws.lambda#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Set to true to publish a new version of the function after updating the code. This has the same effect as\n calling PublishVersion separately.

" + "smithy.api#documentation": "

Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.

" } }, "DryRun": { "target": "com.amazonaws.lambda#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Set to true to validate the request parameters and access permissions without modifying the function\n code.

" + "smithy.api#documentation": "

Set to true to validate the request parameters and access permissions without modifying the function code.

" } }, "RevisionId": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n function that has changed since you last read it.

" + "smithy.api#documentation": "

Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.

" } }, "Architectures": { "target": "com.amazonaws.lambda#ArchitecturesList", "traits": { - "smithy.api#documentation": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64).\n The default value is x86_64.

" + "smithy.api#documentation": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

" } }, "SourceKMSKeyArn": { "target": "com.amazonaws.lambda#KMSKeyArn", "traits": { - "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's \n .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services managed key.

" + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services managed key.

" } } }, @@ -13240,7 +14258,22 @@ } ], "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 Services service, use AddPermission.

", + "aws.iam#conditionKeys": [ + "lambda:VpcIds", + "lambda:SubnetIds", + "lambda:SecurityGroupIds", + "lambda:Layer" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to modify the version-specific settings of an AWS Lambda function", + "relativeDocumentation": "API_UpdateFunctionConfiguration.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Modify the version-specific settings of a Lambda function.

When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Lambda function states.

These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.

To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an Amazon Web Services account or Amazon Web Services service, use AddPermission.

", "smithy.api#examples": [ { "title": "To update a Lambda function's configuration", @@ -13282,7 +14315,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13296,7 +14329,7 @@ "Handler": { "target": "com.amazonaws.lambda#Handler", "traits": { - "smithy.api#documentation": "

The name of the method within your code that Lambda calls to run your function. \nHandler is required if the deployment package is a .zip file archive. The format includes the\n file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information,\n see Lambda programming model.

" + "smithy.api#documentation": "

The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

" } }, "Description": { @@ -13308,19 +14341,19 @@ "Timeout": { "target": "com.amazonaws.lambda#Timeout", "traits": { - "smithy.api#documentation": "

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The\n maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

" + "smithy.api#documentation": "

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment.

" } }, "MemorySize": { "target": "com.amazonaws.lambda#MemorySize", "traits": { - "smithy.api#documentation": "

The amount of memory available to the function at runtime.\n Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

" + "smithy.api#documentation": "

The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

" } }, "VpcConfig": { "target": "com.amazonaws.lambda#VpcConfig", "traits": { - "smithy.api#documentation": "

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC.\n When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more\n information, see Configuring a Lambda function to access resources in a VPC.

" + "smithy.api#documentation": "

For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

" } }, "Environment": { @@ -13332,37 +14365,37 @@ "Runtime": { "target": "com.amazonaws.lambda#Runtime", "traits": { - "smithy.api#documentation": "

The identifier of the function's \n runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in\n an error if you're deploying a function using a container image.

\n

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing\n functions shortly after each runtime is deprecated. For more information, see\n Runtime use after deprecation.

\n

For a list of all currently supported runtimes, see\n Supported runtimes.

" + "smithy.api#documentation": "

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

For a list of all currently supported runtimes, see Supported runtimes.

" } }, "DeadLetterConfig": { "target": "com.amazonaws.lambda#DeadLetterConfig", "traits": { - "smithy.api#documentation": "

A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events\n when they fail processing. For more information, see Dead-letter queues.

" + "smithy.api#documentation": "

A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.

" } }, "KMSKeyArn": { "target": "com.amazonaws.lambda#KMSKeyArn", "traits": { - "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

\n
    \n
  • \n

    The function's environment variables.

    \n
    • \n
  • \n

    The function's Lambda SnapStart snapshots.

    \n
    • \n
  • \n

    When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see \nSpecifying a customer managed key for Lambda.

    \n
    • \n
  • \n

    The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

    \n
    • \n
\n

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

" + "smithy.api#documentation": "

The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

  • The function's environment variables.

  • The function's Lambda SnapStart snapshots.

  • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

  • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

" } }, "TracingConfig": { "target": "com.amazonaws.lambda#TracingConfig", "traits": { - "smithy.api#documentation": "

Set Mode to Active to sample and trace a subset of incoming requests with\nX-Ray.

" + "smithy.api#documentation": "

Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

" } }, "RevisionId": { "target": "com.amazonaws.lambda#String", "traits": { - "smithy.api#documentation": "

Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a\n function that has changed since you last read it.

" + "smithy.api#documentation": "

Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.

" } }, "Layers": { "target": "com.amazonaws.lambda#LayerList", "traits": { - "smithy.api#documentation": "

A list of function layers\n to add to the function's execution environment. Specify each layer by its ARN, including the version.

" + "smithy.api#documentation": "

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

" } }, "FileSystemConfigs": { @@ -13374,13 +14407,13 @@ "ImageConfig": { "target": "com.amazonaws.lambda#ImageConfig", "traits": { - "smithy.api#documentation": "

\n Container image configuration\n values that override the values in the container image Docker file.

" + "smithy.api#documentation": "

Container image configuration values that override the values in the container image Docker file.

" } }, "EphemeralStorage": { "target": "com.amazonaws.lambda#EphemeralStorage", "traits": { - "smithy.api#documentation": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole\n number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" + "smithy.api#documentation": "

The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

" } }, "SnapStart": { @@ -13426,7 +14459,16 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the configuration for asynchronous invocation for a function, version, or alias.

\n

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", + "aws.iam#iamAction": { + "documentation": "Grants permission to modify the configuration for asynchronous invocation for an AWS Lambda function, version, or alias", + "relativeDocumentation": "API_UpdateFunctionEventInvokeConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, + "smithy.api#documentation": "

Updates the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

", "smithy.api#examples": [ { "title": "To update an asynchronous invocation configuration", @@ -13466,7 +14508,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name - my-function (name-only), my-function:v1 (with alias).

    \n
    • \n
  • \n

    \n Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN - 123456789012:function:my-function.

    \n
    • \n
\n

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN.\n If you specify only the function name, it is limited to 64 characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13493,7 +14535,7 @@ "DestinationConfig": { "target": "com.amazonaws.lambda#DestinationConfig", "traits": { - "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

\n

\n Destinations\n

\n
    \n
  • \n

    \n Function - The Amazon Resource Name (ARN) of a Lambda function.

    \n
    • \n
  • \n

    \n Queue - The ARN of a standard SQS queue.

    \n
    • \n
  • \n

    \n Bucket - The ARN of an Amazon S3 bucket.

    \n
    • \n
  • \n

    \n Topic - The ARN of a standard SNS topic.

    \n
    • \n
  • \n

    \n Event Bus - The ARN of an Amazon EventBridge event bus.

    \n
    • \n
\n \n

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

\n " + "smithy.api#documentation": "

A destination for events after they have been sent to a function for processing.

Destinations

  • Function - The Amazon Resource Name (ARN) of a Lambda function.

  • Queue - The ARN of a standard SQS queue.

  • Bucket - The ARN of an Amazon S3 bucket.

  • Topic - The ARN of a standard SNS topic.

  • Event Bus - The ARN of an Amazon EventBridge event bus.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

" } } }, @@ -13527,6 +14569,19 @@ } ], "traits": { + "aws.iam#conditionKeys": [ + "lambda:FunctionArn", + "lambda:FunctionUrlAuthType" + ], + "aws.iam#iamAction": { + "documentation": "Grants permission to update a function url configuration for a Lambda function", + "relativeDocumentation": "API_UpdateFunctionUrlConfig.html", + "resources": { + "required": { + "function": {} + } + } + }, "smithy.api#documentation": "

Updates the configuration for a Lambda function URL.

", "smithy.api#http": { "method": "PUT", @@ -13541,7 +14596,7 @@ "FunctionName": { "target": "com.amazonaws.lambda#FunctionName", "traits": { - "smithy.api#documentation": "

The name or ARN of the Lambda function.

\n

\n Name formats\n

\n
    \n
  • \n

    \n Function name – my-function.

    \n
    • \n
  • \n

    \n Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    \n
    • \n
  • \n

    \n Partial ARN – 123456789012:function:my-function.

    \n
    • \n
\n

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64\n characters in length.

", + "smithy.api#documentation": "

The name or ARN of the Lambda function.

Name formats

  • Function name – my-function.

  • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN – 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13556,19 +14611,19 @@ "AuthType": { "target": "com.amazonaws.lambda#FunctionUrlAuthType", "traits": { - "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

" + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

" } }, "Cors": { "target": "com.amazonaws.lambda#Cors", "traits": { - "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings\n for your function URL.

" + "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings for your function URL.

" } }, "InvokeMode": { "target": "com.amazonaws.lambda#InvokeMode", "traits": { - "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.

    \n
    • \n
  • \n

    \n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

    \n
    • \n
" + "smithy.api#documentation": "

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

" } } }, @@ -13596,14 +14651,14 @@ "AuthType": { "target": "com.amazonaws.lambda#FunctionUrlAuthType", "traits": { - "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated\n users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information,\n see Security and auth model for Lambda function URLs.

", + "smithy.api#documentation": "

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

", "smithy.api#required": {} } }, "Cors": { "target": "com.amazonaws.lambda#Cors", "traits": { - "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings\n for your function URL.

" + "smithy.api#documentation": "

The cross-origin resource sharing (CORS) settings for your function URL.

" } }, "CreationTime": { @@ -13623,7 +14678,7 @@ "InvokeMode": { "target": "com.amazonaws.lambda#InvokeMode", "traits": { - "smithy.api#documentation": "

Use one of the following options:

\n
    \n
  • \n

    \n BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results \n are available when the payload is complete. The maximum payload size is 6 MB.

    \n
    • \n
  • \n

    \n RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using \n the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

    \n
    • \n
" + "smithy.api#documentation": "

Use one of the following options:

  • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

  • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.

" } } }, @@ -13687,7 +14742,7 @@ } }, "traits": { - "smithy.api#documentation": "

The VPC security groups and subnets that are attached to a Lambda function. For more information,\n see Configuring a Lambda\n function to access resources in a VPC.

" + "smithy.api#documentation": "

The VPC security groups and subnets that are attached to a Lambda function. For more information, see Configuring a Lambda function to access resources in a VPC.

" } }, "com.amazonaws.lambda#VpcConfigResponse": { @@ -13745,4 +14800,4 @@ } } } -} +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/lightsail.json b/codegen/sdk/aws-models/lightsail.json index 3532dac7274..82bfe0be72b 100644 --- a/codegen/sdk/aws-models/lightsail.json +++ b/codegen/sdk/aws-models/lightsail.json @@ -545,6 +545,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -704,6 +707,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -793,6 +799,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -869,6 +878,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -945,6 +957,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -2057,6 +2072,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -3214,6 +3232,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -3331,6 +3352,9 @@ { "target": "com.amazonaws.lightsail#InvalidInputException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -3365,6 +3389,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -3488,6 +3515,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -3582,6 +3612,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -3648,6 +3681,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -3718,6 +3754,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -3752,6 +3791,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -3828,6 +3870,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -3956,6 +4001,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -3996,6 +4044,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -4170,6 +4221,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -4386,6 +4440,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -4426,6 +4483,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -4531,6 +4591,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -4624,6 +4687,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -4706,6 +4772,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -4746,6 +4815,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -4976,6 +5048,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -5069,6 +5144,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -5188,6 +5266,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -5283,6 +5364,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -5323,6 +5407,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -5533,6 +5620,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -5623,6 +5713,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -5689,6 +5782,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -5759,6 +5855,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -5793,6 +5892,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -5898,6 +6000,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -5964,6 +6069,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -6027,6 +6135,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -6092,6 +6203,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -6155,6 +6269,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -6230,6 +6347,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -6364,6 +6484,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -6404,6 +6527,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -6509,6 +6635,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -6584,6 +6713,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -6653,6 +6785,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -6728,6 +6863,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -6797,6 +6935,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -6866,6 +7007,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -6948,6 +7092,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -7029,6 +7176,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -7184,6 +7334,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -7253,6 +7406,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -7329,6 +7485,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -7395,6 +7554,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -8156,6 +8318,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -8240,6 +8405,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -8397,6 +8565,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -8624,6 +8795,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -8708,6 +8882,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -8791,6 +8968,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -8872,6 +9052,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -8952,6 +9135,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -9012,6 +9198,9 @@ { "target": "com.amazonaws.lightsail#InvalidInputException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -9074,6 +9263,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -9185,6 +9377,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -9277,6 +9472,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -9357,6 +9555,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -9450,6 +9651,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -9521,6 +9725,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -9577,6 +9784,9 @@ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -9632,6 +9842,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -9696,6 +9909,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -9802,6 +10018,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -9866,6 +10085,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -9976,6 +10198,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -10031,6 +10256,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -10080,6 +10308,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -10163,6 +10394,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -10232,6 +10466,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -10301,6 +10538,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -10375,6 +10615,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -10769,6 +11012,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -10838,6 +11084,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -10912,6 +11161,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -10986,6 +11238,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -11026,6 +11281,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -11101,6 +11359,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -11218,6 +11479,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -11316,6 +11580,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -11385,6 +11652,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -11459,6 +11729,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -11528,6 +11801,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -11602,6 +11878,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -11671,6 +11950,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -11751,6 +12033,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -11791,6 +12076,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -11937,6 +12225,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12000,6 +12291,9 @@ { "target": "com.amazonaws.lightsail#InvalidInputException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12074,6 +12368,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12148,6 +12445,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12217,6 +12517,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12257,6 +12560,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12379,6 +12685,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12453,6 +12762,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12493,6 +12805,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12567,6 +12882,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12647,6 +12965,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12734,6 +13055,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12846,6 +13170,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12915,6 +13242,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -12996,6 +13326,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -13113,6 +13446,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -13223,6 +13559,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -13292,6 +13631,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -13366,6 +13708,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -13434,6 +13779,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -13515,6 +13863,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -13584,6 +13935,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -13897,6 +14251,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -15005,6 +15362,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -15747,7 +16107,7 @@ "name": "lightsail" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes\n everything you need to launch your project quickly - instances (virtual private servers),\n container services, storage buckets, managed databases, SSD-based block storage, static IP\n addresses, load balancers, content delivery network (CDN) distributions, DNS management of\n registered domains, and resource snapshots (backups) - for a low, predictable monthly\n price.

\n

You can manage your Lightsail resources using the Lightsail console, Lightsail API,\n Command Line Interface (CLI), or SDKs. For more information about Lightsail\n concepts and tasks, see the Amazon Lightsail Developer Guide.

\n

This API Reference provides detailed information about the actions, data types,\n parameters, and errors of the Lightsail service. For more information about the supported\n Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see\n Amazon Lightsail Endpoints\n and Quotas in the Amazon Web Services General Reference.

", + "smithy.api#documentation": "

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes\n everything you need to launch your project quickly - instances (virtual private servers),\n container services, storage buckets, managed databases, SSD-based block storage, static IP\n addresses, load balancers, content delivery network (CDN) distributions, DNS management of\n registered domains, and resource snapshots (backups) - for a low, predictable monthly\n price.

\n

You can manage your Lightsail resources using the Lightsail console, Lightsail API,\n Command Line Interface (CLI), or SDKs. For more information about Lightsail\n concepts and tasks, see the Amazon Lightsail Developer Guide.

\n

This API Reference provides detailed information about the actions, data types,\n parameters, and errors of the Lightsail service. For more information about the supported\n Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see\n Amazon Lightsail Endpoints\n and Quotas in the Amazon Web Services General Reference.

", "smithy.api#title": "Amazon Lightsail", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -18063,6 +18423,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -18872,6 +19235,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -19191,6 +19557,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -19325,6 +19694,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -19470,6 +19842,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -19539,6 +19914,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -19749,9 +20127,43 @@ "traits": { "smithy.api#enumValue": "eu-north-1" } + }, + "AP_SOUTHEAST_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-3" + } } } }, + "com.amazonaws.lightsail#RegionSetupInProgressException": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.lightsail#string" + }, + "docs": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

\n Regions\n and Availability Zones for Lightsail\n

" + } + }, + "message": { + "target": "com.amazonaws.lightsail#string" + }, + "tip": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lightsail throws this exception when an operation is performed on resources in an opt-in\n Region that is currently being set up.

", + "smithy.api#error": "client", + "smithy.api#httpError": 428 + } + }, "com.amazonaws.lightsail#RegisterContainerImage": { "type": "operation", "input": { @@ -19770,6 +20182,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -20487,6 +20902,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -20970,6 +21388,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -21109,6 +21530,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -21192,6 +21616,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -21430,6 +21857,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -21563,6 +21993,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -21632,6 +22065,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -21701,6 +22137,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -21914,6 +22353,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -21983,6 +22425,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -22078,6 +22523,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -22209,6 +22657,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -22291,6 +22742,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -22444,6 +22898,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -22505,6 +22962,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -22581,6 +23041,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -22615,6 +23078,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -22744,6 +23210,9 @@ { "target": "com.amazonaws.lightsail#NotFoundException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -23029,6 +23498,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -23105,6 +23577,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -23198,6 +23673,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -23281,6 +23759,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, @@ -23321,6 +23802,9 @@ { "target": "com.amazonaws.lightsail#OperationFailureException" }, + { + "target": "com.amazonaws.lightsail#RegionSetupInProgressException" + }, { "target": "com.amazonaws.lightsail#ServiceException" }, diff --git a/codegen/sdk/aws-models/location.json b/codegen/sdk/aws-models/location.json index db605eafd0a..c1050af8beb 100644 --- a/codegen/sdk/aws-models/location.json +++ b/codegen/sdk/aws-models/location.json @@ -98,7 +98,7 @@ "AllowActions": { "target": "com.amazonaws.location#ApiKeyActionList", "traits": { - "smithy.api#documentation": "

A list of allowed actions that an API key resource grants permissions to\n perform. You must have at least one action for each type of resource. For example,\n if you have a place resource, you must include at least one place action.

\n

The following are valid values for the actions.

\n
    \n
  • \n

    \n Map actions\n

    \n
      \n
    • \n

      \n geo:GetMap* - Allows all actions needed for map rendering.

      \n
      • \n
    \n
    • \n
  • \n

    \n Place actions\n

    \n
      \n
    • \n

      \n geo:SearchPlaceIndexForText - Allows geocoding.

      \n
      • \n
    • \n

      \n geo:SearchPlaceIndexForPosition - Allows reverse \n geocoding.

      \n
      • \n
    • \n

      \n geo:SearchPlaceIndexForSuggestions - Allows generating\n suggestions from text.

      \n
      • \n
    • \n

      \n GetPlace - Allows finding a place by place ID.

      \n
      • \n
    \n
    • \n
  • \n

    \n Route actions\n

    \n
      \n
    • \n

      \n geo:CalculateRoute - Allows point to point routing.

      \n
      • \n
    • \n

      \n geo:CalculateRouteMatrix - Allows calculating a matrix of\n routes.

      \n
      • \n
    \n
    • \n
\n \n

You must use these strings exactly. For example, to provide access to map \n rendering, the only valid action is geo:GetMap* as an input to \n the list. [\"geo:GetMap*\"] is valid but\n [\"geo:GetMapTile\"] is not. Similarly, you cannot use\n [\"geo:SearchPlaceIndexFor*\"] - you must list each of the Place\n actions separately.

\n ", + "smithy.api#documentation": "

A list of allowed actions that an API key resource grants permissions to\n perform. You must have at least one action for each type of resource. For example,\n if you have a place resource, you must include at least one place action.

\n

The following are valid values for the actions.

\n
    \n
  • \n

    \n Map actions\n

    \n
      \n
    • \n

      \n geo:GetMap* - Allows all actions needed for map rendering.

      \n
      • \n
    • \n

      \n geo-maps:GetTile - Allows retrieving map tiles.

      \n
      • \n
    • \n

      \n geo-maps:GetStaticMap - Allows retrieving static map images.

      \n
      • \n
    • \n

      \n geo-maps:* - Allows all actions related to map functionalities.

      \n
      • \n
    \n
    • \n
  • \n

    \n Place actions\n

    \n
      \n
    • \n

      \n geo:SearchPlaceIndexForText - Allows geocoding.

      \n
      • \n
    • \n

      \n geo:SearchPlaceIndexForPosition - Allows reverse geocoding.

      \n
      • \n
    • \n

      \n geo:SearchPlaceIndexForSuggestions - Allows generating suggestions from text.

      \n
      • \n
    • \n

      \n GetPlace - Allows finding a place by place ID.

      \n
      • \n
    • \n

      \n geo-places:Geocode - Allows geocoding using place information.

      \n
      • \n
    • \n

      \n geo-places:ReverseGeocode - Allows reverse geocoding from location coordinates.

      \n
      • \n
    • \n

      \n geo-places:SearchNearby - Allows searching for places near a location.

      \n
      • \n
    • \n

      \n geo-places:SearchText - Allows searching for places based on text input.

      \n
      • \n
    • \n

      \n geo-places:Autocomplete - Allows auto-completion of place names based on text input.

      \n
      • \n
    • \n

      \n geo-places:Suggest - Allows generating suggestions for places based on partial input.

      \n
      • \n
    • \n

      \n geo-places:GetPlace - Allows finding a place by its ID.

      \n
      • \n
    • \n

      \n geo-places:* - Allows all actions related to place services.

      \n
      • \n
    \n
    • \n
  • \n

    \n Route actions\n

    \n
      \n
    • \n

      \n geo:CalculateRoute - Allows point to point routing.

      \n
      • \n
    • \n

      \n geo:CalculateRouteMatrix - Allows calculating a matrix of routes.

      \n
      • \n
    • \n

      \n geo-routes:CalculateRoutes - Allows calculating multiple routes between points.

      \n
      • \n
    • \n

      \n geo-routes:CalculateRouteMatrix - Allows calculating a matrix of routes between points.

      \n
      • \n
    • \n

      \n geo-routes:CalculateIsolines - Allows calculating isolines for a given area.

      \n
      • \n
    • \n

      \n geo-routes:OptimizeWaypoints - Allows optimizing the order of waypoints in a route.

      \n
      • \n
    • \n

      \n geo-routes:SnapToRoads - Allows snapping a route to the nearest roads.

      \n
      • \n
    • \n

      \n geo-routes:* - Allows all actions related to routing functionalities.

      \n
      • \n
    \n
    • \n
\n \n

You must use these strings exactly. For example, to provide access to map \n rendering, the only valid action is geo:GetMap* as an input to \n the list. [\"geo:GetMap*\"] is valid but\n [\"geo:GetMapTile\"] is not. Similarly, you cannot use\n [\"geo:SearchPlaceIndexFor*\"] - you must list each of the Place\n actions separately.

\n ", "smithy.api#length": { "min": 1, "max": 24 @@ -219,7 +219,7 @@ "type": "blob", "traits": { "smithy.api#length": { - "max": 600000 + "max": 700000 }, "smithy.api#sensitive": {} } @@ -452,7 +452,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Evaluates device positions against the geofence geometries from a given geofence\n collection.

\n

This operation always returns an empty response because geofences are asynchronously\n evaluated. The evaluation determines if the device has entered or exited a geofenced\n area, and then publishes one of the following events to Amazon EventBridge:

\n
    \n
  • \n

    \n ENTER if Amazon Location determines that the tracked device has entered\n a geofenced area.

    \n
    • \n
  • \n

    \n EXIT if Amazon Location determines that the tracked device has exited a\n geofenced area.

    \n
    • \n
\n \n

The last geofence that a device was observed within is tracked for 30 days after\n the most recent device position update.

\n \n \n

Geofence evaluation uses the given device position. It does not account for the\n optional Accuracy of a DevicePositionUpdate.

\n \n \n

The DeviceID is used as a string to represent the device. You do not\n need to have a Tracker associated with the DeviceID.

\n ", + "smithy.api#documentation": "

Evaluates device positions against the geofence geometries from a given geofence\n collection.

\n

This operation always returns an empty response because geofences are asynchronously\n evaluated. The evaluation determines if the device has entered or exited a geofenced\n area, and then publishes one of the following events to Amazon EventBridge:

\n
    \n
  • \n

    \n ENTER if Amazon Location determines that the tracked device has entered\n a geofenced area.

    \n
    • \n
  • \n

    \n EXIT if Amazon Location determines that the tracked device has exited a\n geofenced area.

    \n
    • \n
\n \n

The last geofence that a device was observed within is tracked for 30 days after\n the most recent device position update.

\n \n \n

Geofence evaluation uses the given device position. It does not account for the\n optional Accuracy of a DevicePositionUpdate.

\n \n \n

The DeviceID is used as a string to represent the device. You do not\n need to have a Tracker associated with the\n DeviceID.

\n ", "smithy.api#endpoint": { "hostPrefix": "geofencing." }, @@ -723,7 +723,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

A batch request for storing geofence geometries into a given geofence collection, or\n updates the geometry of an existing geofence if a geofence ID is included in the request.

", + "smithy.api#documentation": "

A batch request for storing geofence geometries into a given geofence collection, or\n updates the geometry of an existing geofence if a geofence ID is included in the\n request.

", "smithy.api#endpoint": { "hostPrefix": "geofencing." }, @@ -798,14 +798,14 @@ "Geometry": { "target": "com.amazonaws.location#GeofenceGeometry", "traits": { - "smithy.api#documentation": "

Contains the details to specify the position of the geofence. Can be a\n polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

\n \n

The \n geofence polygon format supports a maximum of 1,000 vertices. The Geofence geobuf format supports a maximum of 100,000 vertices.

\n ", + "smithy.api#documentation": "

Contains the details to specify the position of the geofence. Can be a circle, a\n polygon, or a multipolygon. Polygon and MultiPolygon\n geometries can be defined using their respective parameters, or encoded in Geobuf format\n using the Geobuf parameter. Including multiple geometry types in the same\n request will return a validation error.

\n \n

The geofence Polygon and MultiPolygon formats support a\n maximum of 1,000 total vertices. The Geobuf format supports a maximum\n of 100,000 vertices.

\n ", "smithy.api#required": {} } }, "GeofenceProperties": { "target": "com.amazonaws.location#PropertyMap", "traits": { - "smithy.api#documentation": "

Associates one of more properties with the geofence. A property is a key-value\n pair stored with the geofence and added to any geofence event triggered with that\n geofence.

\n

Format: \"key\" : \"value\"\n

" + "smithy.api#documentation": "

Associates one of more properties with the geofence. A property is a key-value pair\n stored with the geofence and added to any geofence event triggered with that\n geofence.

\n

Format: \"key\" : \"value\"\n

" } } }, @@ -1023,7 +1023,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Calculates a route given the following required parameters:\n DeparturePosition and DestinationPosition. Requires that\n you first create a\n route calculator resource.

\n

By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating the route.

\n

Additional options include:

\n
    \n
  • \n

    \n Specifying a\n departure time using either DepartureTime or\n DepartNow. This calculates a route based on predictive traffic\n data at the given time.

    \n \n

    You can't specify both DepartureTime and\n DepartNow in a single request. Specifying both parameters\n returns a validation error.

    \n     \n
    • \n
  • \n

    \n Specifying a travel\n mode using TravelMode sets the transportation mode used to calculate\n the routes. This also lets you specify additional route preferences in\n CarModeOptions if traveling by Car, or\n TruckModeOptions if traveling by Truck.

    \n \n

    If you specify walking for the travel mode and your data \n provider is Esri, the start and destination must be within 40km.

    \n     \n
    • \n
", + "smithy.api#documentation": "

\n Calculates a route given the following required parameters:\n DeparturePosition and DestinationPosition. Requires that\n you first create a\n route calculator resource.

\n

By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating the route.

\n

Additional options include:

\n
    \n
  • \n

    \n Specifying a\n departure time using either DepartureTime or\n DepartNow. This calculates a route based on predictive traffic\n data at the given time.

    \n \n

    You can't specify both DepartureTime and\n DepartNow in a single request. Specifying both parameters\n returns a validation error.

    \n     \n
    • \n
  • \n

    \n Specifying a travel\n mode using TravelMode sets the transportation mode used to calculate\n the routes. This also lets you specify additional route preferences in\n CarModeOptions if traveling by Car, or\n TruckModeOptions if traveling by Truck.

    \n \n

    If you specify walking for the travel mode and your data \n provider is Esri, the start and destination must be within 40km.

    \n     \n
    • \n
", "smithy.api#endpoint": { "hostPrefix": "routes." }, @@ -1080,7 +1080,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Calculates a route\n matrix given the following required parameters:\n DeparturePositions and DestinationPositions.\n CalculateRouteMatrix calculates routes and returns the travel time and\n travel distance from each departure position to each destination position in the\n request. For example, given departure positions A and B, and destination positions X and\n Y, CalculateRouteMatrix will return time and distance for routes from A to\n X, A to Y, B to X, and B to Y (in that order). The number of results returned (and\n routes calculated) will be the number of DeparturePositions times the\n number of DestinationPositions.

\n \n

Your account is charged for each route calculated, not the number of\n requests.

\n \n

Requires that you first create a\n route calculator resource.

\n

By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating routes.

\n

Additional options include:

\n
    \n
  • \n

    \n Specifying a\n departure time using either DepartureTime or\n DepartNow. This calculates routes based on predictive traffic\n data at the given time.

    \n \n

    You can't specify both DepartureTime and\n DepartNow in a single request. Specifying both parameters\n returns a validation error.

    \n     \n
    • \n
  • \n

    \n Specifying a travel\n mode using TravelMode sets the transportation mode used to calculate\n the routes. This also lets you specify additional route preferences in\n CarModeOptions if traveling by Car, or\n TruckModeOptions if traveling by Truck.

    \n
    • \n
", + "smithy.api#documentation": "

\n Calculates a route\n matrix given the following required parameters:\n DeparturePositions and DestinationPositions.\n CalculateRouteMatrix calculates routes and returns the travel time and\n travel distance from each departure position to each destination position in the\n request. For example, given departure positions A and B, and destination positions X and\n Y, CalculateRouteMatrix will return time and distance for routes from A to\n X, A to Y, B to X, and B to Y (in that order). The number of results returned (and\n routes calculated) will be the number of DeparturePositions times the\n number of DestinationPositions.

\n \n

Your account is charged for each route calculated, not the number of\n requests.

\n \n

Requires that you first create a\n route calculator resource.

\n

By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating routes.

\n

Additional options include:

\n
    \n
  • \n

    \n Specifying a\n departure time using either DepartureTime or\n DepartNow. This calculates routes based on predictive traffic\n data at the given time.

    \n \n

    You can't specify both DepartureTime and\n DepartNow in a single request. Specifying both parameters\n returns a validation error.

    \n     \n
    • \n
  • \n

    \n Specifying a travel\n mode using TravelMode sets the transportation mode used to calculate\n the routes. This also lets you specify additional route preferences in\n CarModeOptions if traveling by Car, or\n TruckModeOptions if traveling by Truck.

    \n
    • \n
", "smithy.api#endpoint": { "hostPrefix": "routes." }, @@ -1105,7 +1105,7 @@ "DeparturePositions": { "target": "com.amazonaws.location#PositionList", "traits": { - "smithy.api#documentation": "

The list of departure (origin) positions for the route matrix. An array of points,\n each of which is itself a 2-value array defined in WGS 84 format:\n [longitude, latitude]. For example, [-123.115,\n 49.285].

\n \n

Depending on the data provider selected in the route calculator resource there may\n be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer\n Guide.

\n \n \n

For route calculators that use Esri as the data provider, if you specify a\n departure that's not located on a road, Amazon Location moves the\n position to the nearest road. The snapped value is available in the\n result in SnappedDeparturePositions.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", + "smithy.api#documentation": "

The list of departure (origin) positions for the route matrix. An array of points,\n each of which is itself a 2-value array defined in WGS 84 format:\n [longitude, latitude]. For example, [-123.115,\n 49.285].

\n \n

Depending on the data provider selected in the route calculator resource there may\n be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer\n Guide.

\n \n \n

For route calculators that use Esri as the data provider, if you specify a\n departure that's not located on a road, Amazon Location moves the\n position to the nearest road. The snapped value is available in the\n result in SnappedDeparturePositions.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", "smithy.api#length": { "min": 1, "max": 350 @@ -1116,7 +1116,7 @@ "DestinationPositions": { "target": "com.amazonaws.location#PositionList", "traits": { - "smithy.api#documentation": "

The list of destination positions for the route matrix. An array of points, each of\n which is itself a 2-value array defined in WGS 84 format:\n [longitude, latitude]. For example, [-122.339,\n 47.615]\n

\n \n

Depending on the data provider selected in the route calculator resource there may\n be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer\n Guide.

\n \n \n

For route calculators that use Esri as the data provider, if you specify a\n destination that's not located on a road, Amazon Location moves the\n position to the nearest road. The snapped value is available in the\n result in SnappedDestinationPositions.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", + "smithy.api#documentation": "

The list of destination positions for the route matrix. An array of points, each of\n which is itself a 2-value array defined in WGS 84 format:\n [longitude, latitude]. For example, [-122.339,\n 47.615]\n

\n \n

Depending on the data provider selected in the route calculator resource there may\n be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer\n Guide.

\n \n \n

For route calculators that use Esri as the data provider, if you specify a\n destination that's not located on a road, Amazon Location moves the\n position to the nearest road. The snapped value is available in the\n result in SnappedDestinationPositions.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", "smithy.api#length": { "min": 1, "max": 350 @@ -1127,7 +1127,7 @@ "TravelMode": { "target": "com.amazonaws.location#TravelMode", "traits": { - "smithy.api#documentation": "

Specifies the mode of transport when calculating a route. Used in estimating the speed\n of travel and road compatibility.

\n

The TravelMode you specify also determines how you specify route\n preferences:

\n
    \n
  • \n

    If traveling by Car use the CarModeOptions\n parameter.

    \n
    • \n
  • \n

    If traveling by Truck use the TruckModeOptions\n parameter.

    \n
    • \n
\n \n

\n Bicycle or Motorcycle are only valid when using\n Grab as a data provider, and only within Southeast Asia.

\n

\n Truck is not available for Grab.

\n

For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

\n \n

Default Value: Car\n

" + "smithy.api#documentation": "

Specifies the mode of transport when calculating a route. Used in estimating the speed\n of travel and road compatibility.

\n

The TravelMode you specify also determines how you specify route\n preferences:

\n
    \n
  • \n

    If traveling by Car use the CarModeOptions\n parameter.

    \n
    • \n
  • \n

    If traveling by Truck use the TruckModeOptions\n parameter.

    \n
    • \n
\n \n

\n Bicycle or Motorcycle are only valid when using\n Grab as a data provider, and only within Southeast Asia.

\n

\n Truck is not available for Grab.

\n

For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

\n \n

Default Value: Car\n

" } }, "DepartureTime": { @@ -1163,7 +1163,7 @@ "Key": { "target": "com.amazonaws.location#ApiKey", "traits": { - "smithy.api#documentation": "

The optional API key to authorize \n the request.

", + "smithy.api#documentation": "

The optional API key to authorize \n the request.

", "smithy.api#httpQuery": "key" } } @@ -1217,7 +1217,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data provider of traffic and road network data used to calculate the routes.\n Indicates one of the available providers:

\n
    \n
  • \n

    \n Esri\n

    \n
    • \n
  • \n

    \n Grab\n

    \n
    • \n
  • \n

    \n Here\n

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data\n providers.

", + "smithy.api#documentation": "

The data provider of traffic and road network data used to calculate the routes.\n Indicates one of the available providers:

\n
    \n
  • \n

    \n Esri\n

    \n
    • \n
  • \n

    \n Grab\n

    \n
    • \n
  • \n

    \n Here\n

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data\n providers.

", "smithy.api#required": {} } }, @@ -1269,21 +1269,21 @@ "DeparturePosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

The start position for the route. Defined in World Geodetic\n System (WGS 84) format:\n [longitude, latitude].

\n
    \n
  • \n

    For example, [-123.115, 49.285]\n

    \n
    • \n
\n \n

If you specify a departure that's not located on a road, Amazon Location moves the position\n to the nearest road. If Esri is the provider for your route calculator,\n specifying a route that is longer than 400 km returns a 400\n RoutesValidationException error.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", + "smithy.api#documentation": "

The start position for the route. Defined in World Geodetic\n System (WGS 84) format:\n [longitude, latitude].

\n
    \n
  • \n

    For example, [-123.115, 49.285]\n

    \n
    • \n
\n \n

If you specify a departure that's not located on a road, Amazon Location moves the position\n to the nearest road. If Esri is the provider for your route calculator,\n specifying a route that is longer than 400 km returns a 400\n RoutesValidationException error.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", "smithy.api#required": {} } }, "DestinationPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

The finish position for the route. Defined in World Geodetic\n System (WGS 84) format:\n [longitude, latitude].

\n
    \n
  • \n

    For example, [-122.339, 47.615]\n

    \n
    • \n
\n \n

If you specify a destination that's not located on a road, Amazon Location moves the position\n to the nearest road.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", + "smithy.api#documentation": "

The finish position for the route. Defined in World Geodetic\n System (WGS 84) format:\n [longitude, latitude].

\n
    \n
  • \n

    For example, [-122.339, 47.615]\n

    \n
    • \n
\n \n

If you specify a destination that's not located on a road, Amazon Location moves the position\n to the nearest road.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", "smithy.api#required": {} } }, "WaypointPositions": { "target": "com.amazonaws.location#WaypointPositionList", "traits": { - "smithy.api#documentation": "

Specifies an ordered list of up to 23 intermediate positions to include along a route\n between the departure position and destination position.

\n
    \n
  • \n

    For example, from the DeparturePosition\n [-123.115, 49.285], the route follows the order that the waypoint\n positions are given [[-122.757, 49.0021],[-122.349, 47.620]]\n

    \n
    • \n
\n \n

If you specify a waypoint position that's not located on a road, Amazon Location moves the position\n to the nearest road.

\n

Specifying more than 23 waypoints returns a 400 ValidationException\n error.

\n

If Esri is the provider for your route calculator, specifying a route that is\n longer than 400 km returns a 400 RoutesValidationException\n error.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", + "smithy.api#documentation": "

Specifies an ordered list of up to 23 intermediate positions to include along a route\n between the departure position and destination position.

\n
    \n
  • \n

    For example, from the DeparturePosition\n [-123.115, 49.285], the route follows the order that the waypoint\n positions are given [[-122.757, 49.0021],[-122.349, 47.620]]\n

    \n
    • \n
\n \n

If you specify a waypoint position that's not located on a road, Amazon Location moves the position\n to the nearest road.

\n

Specifying more than 23 waypoints returns a 400 ValidationException\n error.

\n

If Esri is the provider for your route calculator, specifying a route that is\n longer than 400 km returns a 400 RoutesValidationException\n error.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", "smithy.api#length": { "max": 23 } @@ -1292,7 +1292,7 @@ "TravelMode": { "target": "com.amazonaws.location#TravelMode", "traits": { - "smithy.api#documentation": "

Specifies the mode of transport when calculating a route. Used in estimating the speed\n of travel and road compatibility. You can choose Car, Truck, \n Walking, Bicycle or Motorcycle as options for \n the TravelMode.

\n \n

\n Bicycle and Motorcycle are only valid when using Grab as\n a data provider, and only within Southeast Asia.

\n

\n Truck is not available for Grab.

\n

For more details on the using Grab for routing, including areas of coverage, see\n GrabMaps in the Amazon Location Service Developer Guide.

\n \n

The TravelMode you specify also determines how you specify route\n preferences:

\n
    \n
  • \n

    If traveling by Car use the CarModeOptions\n parameter.

    \n
    • \n
  • \n

    If traveling by Truck use the TruckModeOptions\n parameter.

    \n
    • \n
\n

Default Value: Car\n

" + "smithy.api#documentation": "

Specifies the mode of transport when calculating a route. Used in estimating the speed\n of travel and road compatibility. You can choose Car, Truck, \n Walking, Bicycle or Motorcycle as options for \n the TravelMode.

\n \n

\n Bicycle and Motorcycle are only valid when using Grab as\n a data provider, and only within Southeast Asia.

\n

\n Truck is not available for Grab.

\n

For more details on the using Grab for routing, including areas of coverage, see\n GrabMaps in the Amazon Location Service Developer Guide.

\n \n

The TravelMode you specify also determines how you specify route\n preferences:

\n
    \n
  • \n

    If traveling by Car use the CarModeOptions\n parameter.

    \n
    • \n
  • \n

    If traveling by Truck use the TruckModeOptions\n parameter.

    \n
    • \n
\n

Default Value: Car\n

" } }, "DepartureTime": { @@ -1346,7 +1346,7 @@ "Key": { "target": "com.amazonaws.location#ApiKey", "traits": { - "smithy.api#documentation": "

The optional API key to authorize \n the request.

", + "smithy.api#documentation": "

The optional API key to authorize \n the request.

", "smithy.api#httpQuery": "key" } } @@ -1358,7 +1358,7 @@ "Legs": { "target": "com.amazonaws.location#LegList", "traits": { - "smithy.api#documentation": "

Contains details about each path between a pair of positions included along a route\n such as: StartPosition, EndPosition, Distance,\n DurationSeconds, Geometry, and Steps. The\n number of legs returned corresponds to one fewer than the total number of positions in\n the request.

\n

For example, a route with a departure position and destination position returns one\n leg with the positions snapped to a nearby\n road:

\n
    \n
  • \n

    The StartPosition is the departure position.

    \n
    • \n
  • \n

    The EndPosition is the destination position.

    \n
    • \n
\n

A route with a waypoint between the departure and destination position returns two\n legs with the positions snapped to a nearby road:

\n
    \n
  • \n

    Leg 1: The StartPosition is the departure position . The\n EndPosition is the waypoint positon.

    \n
    • \n
  • \n

    Leg 2: The StartPosition is the waypoint position. The\n EndPosition is the destination position.

    \n
    • \n
", + "smithy.api#documentation": "

Contains details about each path between a pair of positions included along a route\n such as: StartPosition, EndPosition, Distance,\n DurationSeconds, Geometry, and Steps. The\n number of legs returned corresponds to one fewer than the total number of positions in\n the request.

\n

For example, a route with a departure position and destination position returns one\n leg with the positions snapped to a nearby\n road:

\n
    \n
  • \n

    The StartPosition is the departure position.

    \n
    • \n
  • \n

    The EndPosition is the destination position.

    \n
    • \n
\n

A route with a waypoint between the departure and destination position returns two\n legs with the positions snapped to a nearby road:

\n
    \n
  • \n

    Leg 1: The StartPosition is the departure position . The\n EndPosition is the waypoint positon.

    \n
    • \n
  • \n

    Leg 2: The StartPosition is the waypoint position. The\n EndPosition is the destination position.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -1387,7 +1387,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data provider of traffic and road network data used to calculate the route.\n Indicates one of the available providers:

\n
    \n
  • \n

    \n Esri\n

    \n
    • \n
  • \n

    \n Grab\n

    \n
    • \n
  • \n

    \n Here\n

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", + "smithy.api#documentation": "

The data provider of traffic and road network data used to calculate the route.\n Indicates one of the available providers:

\n
    \n
  • \n

    \n Esri\n

    \n
    • \n
  • \n

    \n Grab\n

    \n
    • \n
  • \n

    \n Here\n

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, @@ -1485,7 +1485,7 @@ } }, "Radius": { - "target": "smithy.api#Double", + "target": "com.amazonaws.location#SensitiveDouble", "traits": { "smithy.api#documentation": "

The radius of the circle in meters. Must be greater than zero and no \n larger than 100,000 (100 kilometers).

", "smithy.api#required": {} @@ -1521,7 +1521,8 @@ "min": 3, "max": 3 }, - "smithy.api#pattern": "^[A-Z]{3}$" + "smithy.api#pattern": "^[A-Z]{3}$", + "smithy.api#sensitive": {} } }, "com.amazonaws.location#CountryCode3OrEmpty": { @@ -1531,7 +1532,8 @@ "min": 0, "max": 3 }, - "smithy.api#pattern": "^[A-Z]{3}$|^$" + "smithy.api#pattern": "^[A-Z]{3}$|^$", + "smithy.api#sensitive": {} } }, "com.amazonaws.location#CountryCodeList": { @@ -1633,7 +1635,7 @@ "target": "com.amazonaws.location#KmsKeyId", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "

A key identifier for an\n Amazon Web Services\n KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.\n\t

" + "smithy.api#documentation": "

A key identifier for an Amazon Web Services KMS customer\n managed key. Enter a key ID, key ARN, alias name, or alias ARN.

" } } } @@ -1694,7 +1696,7 @@ ], "traits": { "aws.api#controlPlane": {}, - "smithy.api#documentation": "

Creates an API key resource in your Amazon Web Services account, which lets you grant\n actions for Amazon Location resources to the API key bearer.

\n \n

For more information, see Using API keys.

\n ", + "smithy.api#documentation": "

Creates an API key resource in your Amazon Web Services account, which lets you grant\n actions for Amazon Location resources to the API key bearer.

\n \n

For more information, see Using API keys.

\n ", "smithy.api#endpoint": { "hostPrefix": "cp.metadata." }, @@ -1754,7 +1756,7 @@ "Key": { "target": "com.amazonaws.location#ApiKey", "traits": { - "smithy.api#documentation": "

The key value/string of an API key. This value is used when making API calls to\n authorize the call. For example, see GetMapGlyphs.

", + "smithy.api#documentation": "

The key value/string of an API key. This value is used when making API calls to\n authorize the call. For example, see GetMapGlyphs.

", "smithy.api#required": {} } }, @@ -1944,7 +1946,7 @@ "target": "smithy.api#String", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "

Specifies the geospatial data provider for the new place index.

\n \n

This field is case-sensitive. Enter the valid values as shown. For example,\n entering HERE returns an error.

\n \n

Valid values include:

\n \n

For additional information , see Data\n providers on the Amazon Location Service Developer Guide.

", + "smithy.api#documentation": "

Specifies the geospatial data provider for the new place index.

\n \n

This field is case-sensitive. Enter the valid values as shown. For example,\n entering HERE returns an error.

\n \n

Valid values include:

\n \n

For additional information , see Data\n providers on the Amazon Location Service developer guide.

", "smithy.api#required": {} } }, @@ -2058,7 +2060,7 @@ "target": "smithy.api#String", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "

Specifies the data provider of traffic and road network data.

\n \n

This field is case-sensitive. Enter the valid values as shown. For example,\n entering HERE returns an error.

\n \n

Valid values include:

\n \n

For additional information , see Data\n providers on the Amazon Location Service Developer Guide.

", + "smithy.api#documentation": "

Specifies the data provider of traffic and road network data.

\n \n

This field is case-sensitive. Enter the valid values as shown. For example,\n entering HERE returns an error.

\n \n

Valid values include:

\n \n

For additional information , see Data\n providers on the Amazon Location Service Developer Guide.

", "smithy.api#required": {} } }, @@ -2718,7 +2720,7 @@ "KmsKeyId": { "target": "com.amazonaws.location#KmsKeyId", "traits": { - "smithy.api#documentation": "

A key identifier for an\n Amazon Web Services\n KMS customer managed key assigned to the Amazon Location resource

" + "smithy.api#documentation": "

A key identifier for an Amazon Web Services KMS customer\n managed key assigned to the Amazon Location resource

" } }, "Tags": { @@ -3092,7 +3094,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data provider of geospatial data. Values can be one of the following:

\n
    \n
  • \n

    \n Esri\n

    \n
    • \n
  • \n

    \n Grab\n

    \n
    • \n
  • \n

    \n Here\n

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", + "smithy.api#documentation": "

The data provider of geospatial data. Values can be one of the following:

\n
    \n
  • \n

    \n Esri\n

    \n
    • \n
  • \n

    \n Grab\n

    \n
    • \n
  • \n

    \n Here\n

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, @@ -3212,7 +3214,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data provider of traffic and road network data. Indicates one of the available\n providers:

\n
    \n
  • \n

    \n Esri\n

    \n
    • \n
  • \n

    \n Grab\n

    \n
    • \n
  • \n

    \n Here\n

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", + "smithy.api#documentation": "

The data provider of traffic and road network data. Indicates one of the available\n providers:

\n
    \n
  • \n

    \n Esri\n

    \n
    • \n
  • \n

    \n Grab\n

    \n
    • \n
  • \n

    \n Here\n

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, @@ -3670,7 +3672,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Evaluates device positions against\n geofence geometries from a given geofence collection. The event forecasts three states for which\n a device can be in relative to a geofence:

\n

\n ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

\n

\n EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

\n

\n IDLE: If a device is inside of a geofence, and the device is not moving.

", + "smithy.api#documentation": "

This action forecasts future geofence events that are likely to occur within a\n specified time horizon if a device continues moving at its current speed. Each\n forecasted event is associated with a geofence from a provided geofence collection. A\n forecast event can have one of the following states:

\n

\n ENTER: The device position is outside the referenced geofence, but the\n device may cross into the geofence during the forecasting time horizon if it maintains\n its current speed.

\n

\n EXIT: The device position is inside the referenced geofence, but the\n device may leave the geofence during the forecasted time horizon if the device maintains\n it's current speed.

\n

\n IDLE:The device is inside the geofence, and it will remain inside the\n geofence through the end of the time horizon if the device maintains it's current\n speed.

\n \n

Heading direction is not considered in the current version. The API takes a\n conservative approach and includes events that can occur for any heading.

\n ", "smithy.api#endpoint": { "hostPrefix": "geofencing." }, @@ -3708,7 +3710,7 @@ } }, "traits": { - "smithy.api#documentation": "

The device's position, IP address, and WiFi access points.

" + "smithy.api#documentation": "

The device's position and speed.

" } }, "com.amazonaws.location#ForecastGeofenceEventsRequest": { @@ -3725,14 +3727,14 @@ "DeviceState": { "target": "com.amazonaws.location#ForecastGeofenceEventsDeviceState", "traits": { - "smithy.api#documentation": "

The device's state, including current position and speed.

", + "smithy.api#documentation": "

Represents the device's state, including its current position and speed. When speed is\n omitted, this API performs a containment check. The\n containment check operation returns IDLE events\n for geofences where the device is currently inside of, but no other events.

", "smithy.api#required": {} } }, "TimeHorizonMinutes": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

Specifies the time horizon in minutes for the forecasted events.

", + "smithy.api#documentation": "

The forward-looking time window for forecasting, specified in minutes. The API only\n returns events that are predicted to occur within this time horizon. When no value is\n specified, this API performs a containment check. The\n containment check operation returns IDLE events\n for geofences where the device is currently inside of, but no other events.

", "smithy.api#range": { "min": 0 } @@ -3741,13 +3743,13 @@ "DistanceUnit": { "target": "com.amazonaws.location#DistanceUnit", "traits": { - "smithy.api#documentation": "

The distance unit used for the NearestDistance property returned in a forecasted event.\n The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers\n is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.\n

\n

Default Value: Kilometers\n

" + "smithy.api#documentation": "

The distance unit used for the NearestDistance property returned in a\n forecasted event. The measurement system must match for DistanceUnit and\n SpeedUnit; if Kilometers is specified for\n DistanceUnit, then SpeedUnit must be\n KilometersPerHour.

\n

Default Value: Kilometers\n

" } }, "SpeedUnit": { "target": "com.amazonaws.location#SpeedUnit", "traits": { - "smithy.api#documentation": "

The speed unit for the device captured by the device state. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers\n is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

\n

Default Value: KilometersPerHour.

" + "smithy.api#documentation": "

The speed unit for the device captured by the device state. The measurement system\n must match for DistanceUnit and SpeedUnit; if\n Kilometers is specified for DistanceUnit, then\n SpeedUnit must be KilometersPerHour.

\n

Default Value: KilometersPerHour.

" } }, "NextToken": { @@ -3842,14 +3844,14 @@ "EventType": { "target": "com.amazonaws.location#ForecastedGeofenceEventType", "traits": { - "smithy.api#documentation": "

The event type, forecasting three states for which\n a device can be in relative to a geofence:

\n

\n ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

\n

\n EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

\n

\n IDLE: If a device is inside of a geofence, and the device is not moving.

", + "smithy.api#documentation": "

The event type, forecasting three states for which a device can be in relative to a\n geofence:

\n

\n ENTER: If a device is outside of a geofence, but would breach the fence\n if the device is moving at its current speed within time horizon window.

\n

\n EXIT: If a device is inside of a geofence, but would breach the fence if\n the device is moving at its current speed within time horizon window.

\n

\n IDLE: If a device is inside of a geofence, and the device is not\n moving.

", "smithy.api#required": {} } }, "ForecastedBreachTime": { "target": "com.amazonaws.location#Timestamp", "traits": { - "smithy.api#documentation": "

The forecasted time the device will breach the geofence in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ\n

" + "smithy.api#documentation": "

The forecasted time the device will breach the geofence in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ\n

" } }, "GeofenceProperties": { @@ -3860,7 +3862,7 @@ } }, "traits": { - "smithy.api#documentation": "

A forecasted event represents a geofence event in relation to the requested device state, that may occur\n given the provided device state and time horizon.

" + "smithy.api#documentation": "

A forecasted event represents a geofence event in relation to the requested device\n state, that may occur given the provided device state and time horizon.

" } }, "com.amazonaws.location#ForecastedEventsList": { @@ -3998,7 +4000,11 @@ "Polygon": { "target": "com.amazonaws.location#LinearRings", "traits": { - "smithy.api#documentation": "

A polygon is a list of linear rings which are each made up of a list of\n vertices.

\n

Each vertex is a 2-dimensional point of the form: [longitude, latitude].\n This is represented as an array of doubles of length 2 (so [double,\n double]).

\n

An array of 4 or more vertices, where the first and last vertex are the same (to form\n a closed boundary), is called a linear ring. The linear ring vertices must be listed in\n counter-clockwise order around the ring’s interior. The linear ring is represented as an\n array of vertices, or an array of arrays of doubles ([[double, double], ...]).

\n

A geofence consists of a single linear ring. To allow for future expansion, the\n Polygon parameter takes an array of linear rings, which is represented as an array of\n arrays of arrays of doubles ([[[double, double], ...], ...]).

\n

A linear ring for use in geofences can consist of between 4 and 1,000 vertices.

" + "smithy.api#documentation": "

A Polygon is a list of up to 250 linear rings which represent the shape\n of a geofence. This list must include 1 exterior ring (representing\n the outer perimeter of the geofence), and can optionally include up to 249 interior\n rings (representing polygonal spaces within the perimeter, which are excluded from the\n geofence area).

\n

A linear ring is an array of 4 or more vertices, where the first and last vertex are\n the same (to form a closed boundary). Each vertex is a 2-dimensional point represented\n as an array of doubles of length 2: [longitude, latitude].

\n

Each linear ring is represented as an array of arrays of doubles ([[longitude,\n latitude], [longitude, latitude], ...]). The vertices for the exterior ring\n must be listed in counter-clockwise sequence. Vertices for all\n interior rings must be listed in clockwise sequence.

\n

The list of linear rings that describe the entire Polygon is represented\n as an array of arrays of arrays of doubles ([[[longitude, latitude], [longitude,\n latitude], ...], [[longitude, latitude], [longitude, latitude], ...], ...]).\n The exterior ring must be listed first, before any interior rings.

\n \n

The following additional requirements and limitations apply to geometries defined\n using the Polygon parameter:

\n
    \n
  • \n

    The entire Polygon must consist of no more than 1,000\n vertices, including all vertices from the exterior ring and all interior\n rings.

    \n
    • \n
  • \n

    Rings must not touch or cross each other.

    \n
    • \n
  • \n

    All interior rings must be fully contained within the exterior\n ring.

    \n
    • \n
  • \n

    Interior rings must not contain other interior rings.

    \n
    • \n
  • \n

    No ring is permitted to intersect itself.

    \n
    • \n
\n ", + "smithy.api#length": { + "min": 1, + "max": 250 + } } }, "Circle": { @@ -4010,12 +4016,22 @@ "Geobuf": { "target": "com.amazonaws.location#Base64EncodedGeobuf", "traits": { - "smithy.api#documentation": "

Geobuf is a compact binary encoding for geographic data that provides lossless compression of GeoJSON polygons. The Geobuf must be Base64-encoded.

\n

A polygon in Geobuf format can have up to 100,000 vertices.

" + "smithy.api#documentation": "

Geobuf is a compact binary encoding for geographic data that provides lossless\n compression of GeoJSON polygons. The Geobuf must be Base64-encoded.

\n

This parameter can contain a Geobuf-encoded GeoJSON geometry object of type\n Polygon\n OR\n MultiPolygon. For more information and specific configuration requirements\n for these object types, see Polygon and MultiPolygon.

\n \n

The following limitations apply specifically to geometries defined using the\n Geobuf parameter, and supercede the corresponding limitations of\n the Polygon and MultiPolygon parameters:

\n
    \n
  • \n

    A Polygon in Geobuf format can have up to 25,000\n rings and up to 100,000 total vertices, including all vertices from all\n component rings.

    \n
    • \n
  • \n

    A MultiPolygon in Geobuf format can contain up\n to 10,000 Polygons and up to 100,000 total vertices, including\n all vertices from all component Polygons.

    \n
    • \n
\n " + } + }, + "MultiPolygon": { + "target": "com.amazonaws.location#MultiLinearRings", + "traits": { + "smithy.api#documentation": "

A MultiPolygon is a list of up to 250 Polygon elements which\n represent the shape of a geofence. The Polygon components of a\n MultiPolygon geometry can define separate geographical areas that are\n considered part of the same geofence, perimeters of larger exterior areas with smaller\n interior spaces that are excluded from the geofence, or some combination of these use\n cases to form complex geofence boundaries.

\n

For more information and specific configuration requirements for the\n Polygon components that form a MultiPolygon, see Polygon.

\n \n

The following additional requirements and limitations apply to geometries defined\n using the MultiPolygon parameter:

\n
    \n
  • \n

    The entire MultiPolygon must consist of no more than 1,000\n vertices, including all vertices from all component\n Polygons.

    \n
    • \n
  • \n

    Each edge of a component Polygon must intersect no more than\n 5 edges from other Polygons. Parallel edges that are shared but\n do not cross are not counted toward this limit.

    \n
    • \n
  • \n

    The total number of intersecting edges of component Polygons\n must be no more than 100,000. Parallel edges that are shared but do not\n cross are not counted toward this limit.

    \n
    • \n
\n ", + "smithy.api#length": { + "min": 1, + "max": 250 + } } } }, "traits": { - "smithy.api#documentation": "

Contains the geofence geometry details.

\n

A geofence geometry is made up of either a polygon or a circle. Can be a\n polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

\n \n

Amazon Location doesn't currently support polygons with holes, multipolygons, polygons\n that are wound clockwise, or that cross the antimeridian.

\n " + "smithy.api#documentation": "

Contains the geofence geometry details.

\n

A geofence geometry can be a circle, a polygon, or a multipolygon.\n Polygon and MultiPolygon geometries can be defined using\n their respective parameters, or encoded in Geobuf format using the Geobuf\n parameter. Including multiple geometry types in the same request will return a\n validation error.

\n \n

Amazon Location doesn't currently support polygons that cross the antimeridian.

\n " } }, "com.amazonaws.location#GetDevicePosition": { @@ -4260,7 +4276,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Retrieves the geofence details from a geofence collection.

\n \n

The returned geometry will always match the geometry format used when the geofence was created.

\n ", + "smithy.api#documentation": "

Retrieves the geofence details from a geofence collection.

\n \n

The returned geometry will always match the geometry format used when the geofence\n was created.

\n ", "smithy.api#endpoint": { "hostPrefix": "geofencing." }, @@ -4305,7 +4321,7 @@ "Geometry": { "target": "com.amazonaws.location#GeofenceGeometry", "traits": { - "smithy.api#documentation": "

Contains the geofence geometry details describing a polygon or a circle.

", + "smithy.api#documentation": "

Contains the geofence geometry details describing the position of the geofence. Can be\n a circle, a polygon, or a multipolygon.

", "smithy.api#required": {} } }, @@ -4333,7 +4349,7 @@ "GeofenceProperties": { "target": "com.amazonaws.location#PropertyMap", "traits": { - "smithy.api#documentation": "

User defined properties of the geofence. A property is a key-value\n pair stored with the geofence and added to any geofence event triggered with that\n geofence.

\n

Format: \"key\" : \"value\"\n

" + "smithy.api#documentation": "

User defined properties of the geofence. A property is a key-value pair stored with\n the geofence and added to any geofence event triggered with that geofence.

\n

Format: \"key\" : \"value\"\n

" } } } @@ -4389,7 +4405,7 @@ "FontStack": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.

\n

Valid font stacks for Esri styles:

\n
    \n
  • \n

    VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu\n Medium | Ubuntu Italic | Ubuntu Regular |\n Ubuntu Bold\n

    \n
    • \n
  • \n

    VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu\n Regular | Ubuntu Light | Ubuntu Bold\n

    \n
    • \n
  • \n

    VectorEsriTopographic – Noto Sans Italic | Noto Sans\n Regular | Noto Sans Bold | Noto Serif\n Regular | Roboto Condensed Light Italic\n

    \n
    • \n
  • \n

    VectorEsriStreets – Arial Regular | Arial Italic |\n Arial Bold\n

    \n
    • \n
  • \n

    VectorEsriNavigation – Arial Regular | Arial Italic\n | Arial Bold\n

    \n
    • \n
\n

Valid font stacks for HERE Technologies styles:

\n
    \n
  • \n

    VectorHereContrast – Fira \n GO Regular | Fira GO Bold\n

    \n
    • \n
  • \n

    VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – \n Fira GO Italic | Fira GO Map | \n Fira GO Map Bold | Noto Sans CJK JP Bold | \n Noto Sans CJK JP Light | \n Noto Sans CJK JP Regular\n

    \n
    • \n
\n

Valid font stacks for GrabMaps styles:

\n
    \n
  • \n

    VectorGrabStandardLight, VectorGrabStandardDark – \n Noto Sans Regular |\n Noto Sans Medium |\n Noto Sans Bold\n

    \n
    • \n
\n

Valid font stacks for Open Data styles:

\n
    \n
  • \n

    VectorOpenDataStandardLight, VectorOpenDataStandardDark,\n VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – \n Amazon Ember Regular,Noto Sans Regular |\n Amazon Ember Bold,Noto Sans Bold | \n Amazon Ember Medium,Noto Sans Medium |\n Amazon Ember Regular Italic,Noto Sans Italic | \n Amazon Ember Condensed RC Regular,Noto Sans Regular | \n Amazon Ember Condensed RC Bold,Noto Sans Bold |\n Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular |\n Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic \n Condensed Bold |\n Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold |\n Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic \n Regular |\n Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic \n Condensed Regular |\n Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium\n

    \n
    • \n
\n \n

The fonts used by the Open Data map styles are combined fonts\n that use Amazon Ember for most glyphs but Noto Sans \n for glyphs unsupported by Amazon Ember.

\n ", + "smithy.api#documentation": "

A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.

\n

Valid font stacks for Esri styles:

\n
    \n
  • \n

    VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu\n Medium | Ubuntu Italic | Ubuntu Regular |\n Ubuntu Bold\n

    \n
    • \n
  • \n

    VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu\n Regular | Ubuntu Light | Ubuntu Bold\n

    \n
    • \n
  • \n

    VectorEsriTopographic – Noto Sans Italic | Noto Sans\n Regular | Noto Sans Bold | Noto Serif\n Regular | Roboto Condensed Light Italic\n

    \n
    • \n
  • \n

    VectorEsriStreets – Arial Regular | Arial Italic |\n Arial Bold\n

    \n
    • \n
  • \n

    VectorEsriNavigation – Arial Regular | Arial Italic\n | Arial Bold\n

    \n
    • \n
\n

Valid font stacks for HERE Technologies styles:

\n
    \n
  • \n

    VectorHereContrast – Fira \n GO Regular | Fira GO Bold\n

    \n
    • \n
  • \n

    VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – \n Fira GO Italic | Fira GO Map | \n Fira GO Map Bold | Noto Sans CJK JP Bold | \n Noto Sans CJK JP Light | \n Noto Sans CJK JP Regular\n

    \n
    • \n
\n

Valid font stacks for GrabMaps styles:

\n
    \n
  • \n

    VectorGrabStandardLight, VectorGrabStandardDark – \n Noto Sans Regular |\n Noto Sans Medium |\n Noto Sans Bold\n

    \n
    • \n
\n

Valid font stacks for Open Data styles:

\n
    \n
  • \n

    VectorOpenDataStandardLight, VectorOpenDataStandardDark,\n VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – \n Amazon Ember Regular,Noto Sans Regular |\n Amazon Ember Bold,Noto Sans Bold | \n Amazon Ember Medium,Noto Sans Medium |\n Amazon Ember Regular Italic,Noto Sans Italic | \n Amazon Ember Condensed RC Regular,Noto Sans Regular | \n Amazon Ember Condensed RC Bold,Noto Sans Bold |\n Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular |\n Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic \n Condensed Bold |\n Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold |\n Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic \n Regular |\n Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic \n Condensed Regular |\n Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium\n

    \n
    • \n
\n \n

The fonts used by the Open Data map styles are combined fonts\n that use Amazon Ember for most glyphs but Noto Sans \n for glyphs unsupported by Amazon Ember.

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4406,7 +4422,7 @@ "Key": { "target": "com.amazonaws.location#ApiKey", "traits": { - "smithy.api#documentation": "

The optional API key to authorize \n the request.

", + "smithy.api#documentation": "

The optional API key to authorize \n the request.

", "smithy.api#httpQuery": "key" } } @@ -4503,7 +4519,7 @@ "Key": { "target": "com.amazonaws.location#ApiKey", "traits": { - "smithy.api#documentation": "

The optional API key to authorize \n the request.

", + "smithy.api#documentation": "

The optional API key to authorize \n the request.

", "smithy.api#httpQuery": "key" } } @@ -4586,7 +4602,7 @@ "Key": { "target": "com.amazonaws.location#ApiKey", "traits": { - "smithy.api#documentation": "

The optional API key to authorize \n the request.

", + "smithy.api#documentation": "

The optional API key to authorize \n the request.

", "smithy.api#httpQuery": "key" } } @@ -4699,7 +4715,7 @@ "Key": { "target": "com.amazonaws.location#ApiKey", "traits": { - "smithy.api#documentation": "

The optional API key to authorize \n the request.

", + "smithy.api#documentation": "

The optional API key to authorize \n the request.

", "smithy.api#httpQuery": "key" } } @@ -4757,7 +4773,7 @@ } ], "traits": { - "smithy.api#documentation": "

Finds a place by its unique ID. A PlaceId is returned by other search\n operations.

\n \n

A PlaceId is valid only if all of the following are the same in the original\n search request and the call to GetPlace.

\n
    \n
  • \n

    Customer Amazon Web Services account

    \n
    • \n
  • \n

    Amazon Web Services Region

    \n
    • \n
  • \n

    Data provider specified in the place index resource

    \n
    • \n
\n ", + "smithy.api#documentation": "

Finds a place by its unique ID. A PlaceId is returned by other search\n operations.

\n \n

A PlaceId is valid only if all of the following are the same in the original\n search request and the call to GetPlace.

\n
    \n
  • \n

    Customer Amazon Web Services account

    \n
    • \n
  • \n

    Amazon Web Services Region

    \n
    • \n
  • \n

    Data provider specified in the place index resource

    \n
    • \n
\n \n \n

If your Place index resource is configured with Grab as your geolocation \n provider and Storage as Intended use, the GetPlace operation is unavailable. For \n more information, see AWS service \n terms.

\n ", "smithy.api#endpoint": { "hostPrefix": "places." }, @@ -4797,7 +4813,7 @@ "Key": { "target": "com.amazonaws.location#ApiKey", "traits": { - "smithy.api#documentation": "

The optional API key to authorize \n the request.

", + "smithy.api#documentation": "

The optional API key to authorize \n the request.

", "smithy.api#httpQuery": "key" } } @@ -4930,14 +4946,14 @@ "StartPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

The starting position of the leg. Follows the format\n [longitude,latitude].

\n \n

If the StartPosition isn't located on a road, it's snapped to a\n nearby road.

\n ", + "smithy.api#documentation": "

The starting position of the leg. Follows the format\n [longitude,latitude].

\n \n

If the StartPosition isn't located on a road, it's snapped to a\n nearby road.

\n ", "smithy.api#required": {} } }, "EndPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

The terminating position of the leg. Follows the format\n [longitude,latitude].

\n \n

If the EndPosition isn't located on a road, it's snapped to a nearby\n road.

\n ", + "smithy.api#documentation": "

The terminating position of the leg. Follows the format\n [longitude,latitude].

\n \n

If the EndPosition isn't located on a road, it's snapped to a nearby\n road.

\n ", "smithy.api#required": {} } }, @@ -4976,7 +4992,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the calculated route's details for each path between a pair of positions. The\n number of legs returned corresponds to one fewer than the total number of positions in\n the request.

\n

For example, a route with a departure position and destination position returns one\n leg with the positions snapped to a nearby\n road:

\n
    \n
  • \n

    The StartPosition is the departure position.

    \n
    • \n
  • \n

    The EndPosition is the destination position.

    \n
    • \n
\n

A route with a waypoint between the departure and destination position returns two\n legs with the positions snapped to a nearby road:

\n
    \n
  • \n

    Leg 1: The StartPosition is the departure position . The\n EndPosition is the waypoint positon.

    \n
    • \n
  • \n

    Leg 2: The StartPosition is the waypoint position. The\n EndPosition is the destination position.

    \n
    • \n
" + "smithy.api#documentation": "

Contains the calculated route's details for each path between a pair of positions. The\n number of legs returned corresponds to one fewer than the total number of positions in\n the request.

\n

For example, a route with a departure position and destination position returns one\n leg with the positions snapped to a nearby\n road:

\n
    \n
  • \n

    The StartPosition is the departure position.

    \n
    • \n
  • \n

    The EndPosition is the destination position.

    \n
    • \n
\n

A route with a waypoint between the departure and destination position returns two\n legs with the positions snapped to a nearby road:

\n
    \n
  • \n

    Leg 1: The StartPosition is the departure position . The\n EndPosition is the waypoint positon.

    \n
    • \n
  • \n

    Leg 2: The StartPosition is the waypoint position. The\n EndPosition is the destination position.

    \n
    • \n
" } }, "com.amazonaws.location#LegGeometry": { @@ -5314,7 +5330,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the geofence collection details.

\n \n

The returned geometry will always match the geometry format used when the geofence was created.

\n " + "smithy.api#documentation": "

Contains the geofence collection details.

\n \n

The returned geometry will always match the geometry format used when the geofence\n was created.

\n " } }, "com.amazonaws.location#ListGeofenceCollectionsResponseEntryList": { @@ -5336,7 +5352,7 @@ "Geometry": { "target": "com.amazonaws.location#GeofenceGeometry", "traits": { - "smithy.api#documentation": "

Contains the geofence geometry details describing a polygon or a circle.

", + "smithy.api#documentation": "

Contains the geofence geometry details describing the position of the geofence. Can be\n a circle, a polygon, or a multipolygon.

", "smithy.api#required": {} } }, @@ -5364,12 +5380,12 @@ "GeofenceProperties": { "target": "com.amazonaws.location#PropertyMap", "traits": { - "smithy.api#documentation": "

User defined properties of the geofence. A property is a key-value\n pair stored with the geofence and added to any geofence event triggered with that\n geofence.

\n

Format: \"key\" : \"value\"\n

" + "smithy.api#documentation": "

User defined properties of the geofence. A property is a key-value pair stored with\n the geofence and added to any geofence event triggered with that geofence.

\n

Format: \"key\" : \"value\"\n

" } } }, "traits": { - "smithy.api#documentation": "

Contains a list of geofences stored in a given geofence collection.

\n \n

The returned geometry will always match the geometry format used when the geofence was created.

\n " + "smithy.api#documentation": "

Contains a list of geofences stored in a given geofence collection.

\n \n

The returned geometry will always match the geometry format used when the geofence\n was created.

\n " } }, "com.amazonaws.location#ListGeofenceResponseEntryList": { @@ -5850,7 +5866,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data provider of geospatial data. Values can be one of the following:

\n
    \n
  • \n

    \n Esri\n

    \n
    • \n
  • \n

    \n Grab\n

    \n
    • \n
  • \n

    \n Here\n

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", + "smithy.api#documentation": "

The data provider of geospatial data. Values can be one of the following:

\n
    \n
  • \n

    \n Esri\n

    \n
    • \n
  • \n

    \n Grab\n

    \n
    • \n
  • \n

    \n Here\n

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, @@ -5989,7 +6005,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data provider of traffic and road network data. Indicates one of the available\n providers:

\n
    \n
  • \n

    \n Esri\n

    \n
    • \n
  • \n

    \n Grab\n

    \n
    • \n
  • \n

    \n Here\n

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", + "smithy.api#documentation": "

The data provider of traffic and road network data. Indicates one of the available\n providers:

\n
    \n
  • \n

    \n Esri\n

    \n
    • \n
  • \n

    \n Grab\n

    \n
    • \n
  • \n

    \n Here\n

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, @@ -7170,14 +7186,14 @@ "Style": { "target": "com.amazonaws.location#MapStyle", "traits": { - "smithy.api#documentation": "

Specifies the map style selected from an available data provider.

\n

Valid Esri map styles:

\n
    \n
  • \n

    \n VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A\n vector basemap with a dark gray, neutral background with minimal colors, labels,\n and features that's designed to draw attention to your thematic content.

    \n
    • \n
  • \n

    \n RasterEsriImagery – The Esri Imagery map style. A raster basemap\n that provides one meter or better satellite and aerial imagery in many parts of\n the world and lower resolution satellite imagery worldwide.

    \n
    • \n
  • \n

    \n VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style,\n which provides a detailed vector basemap with a light gray, neutral background\n style with minimal colors, labels, and features that's designed to draw\n attention to your thematic content.

    \n
    • \n
  • \n

    \n VectorEsriTopographic – The Esri Light map style, which provides\n a detailed vector basemap with a classic Esri map style.

    \n
    • \n
  • \n

    \n VectorEsriStreets – The Esri Street Map style, which\n provides a detailed vector basemap for the world symbolized with a classic Esri\n street map style. The vector tile layer is similar in content and style to the\n World Street Map raster map.

    \n
    • \n
  • \n

    \n VectorEsriNavigation – The Esri Navigation map style, which\n provides a detailed basemap for the world symbolized with a custom navigation\n map style that's designed for use during the day in mobile devices.

    \n
    • \n
\n

Valid HERE\n Technologies map styles:

\n
    \n
  • \n

    \n VectorHereContrast – The HERE Contrast (Berlin) map style is a \n high contrast\n detailed base map of the world that blends 3D and 2D rendering.

    \n \n

    The VectorHereContrast style has been renamed from \n VectorHereBerlin. \n VectorHereBerlin has been deprecated, but will continue to work in \n applications that use it.

    \n     \n
    • \n
  • \n

    \n VectorHereExplore – A default HERE map style containing a \n neutral, global map and its features including roads, buildings, landmarks, \n and water features. It also now includes a fully designed map of Japan.

    \n
    • \n
  • \n

    \n VectorHereExploreTruck – A global map containing truck \n restrictions and attributes (e.g. width / height / HAZMAT) symbolized with \n highlighted segments and icons on top of HERE Explore to support use cases \n within transport and logistics.

    \n
    • \n
  • \n

    \n RasterHereExploreSatellite – A global map containing high\n resolution satellite imagery.

    \n
    • \n
  • \n

    \n HybridHereExploreSatellite – A global map displaying the road \n network, street names, and city labels over satellite imagery. This style \n will automatically retrieve both raster and vector tiles, and your charges \n will be based on total tiles retrieved.

    \n \n

    Hybrid styles use both vector and raster tiles when rendering the \n map that you see. This means that more tiles are retrieved than when using \n either vector or raster tiles alone. Your charges will include all tiles \n retrieved.

    \n     \n
    • \n
\n

Valid GrabMaps map styles:

\n
    \n
  • \n

    \n VectorGrabStandardLight – The Grab Standard Light \n map style provides a basemap with detailed land use coloring, \n area names, roads, landmarks, and points of interest covering \n Southeast Asia.

    \n
    • \n
  • \n

    \n VectorGrabStandardDark – The Grab Standard Dark \n map style provides a dark variation of the standard basemap \n covering Southeast Asia.

    \n
    • \n
\n \n

Grab provides maps only for countries in Southeast Asia, and is only available \n in the Asia Pacific (Singapore) Region (ap-southeast-1).\n For more information, see GrabMaps countries and area covered.

\n \n

Valid Open Data map styles:

\n
    \n
  • \n

    \n VectorOpenDataStandardLight – The Open Data Standard Light \n map style provides a detailed basemap for the world suitable for\n website and mobile application use. The map includes highways major roads, \n minor roads, railways, water features, cities, parks, landmarks, building\n footprints, and administrative boundaries.

    \n
    • \n
  • \n

    \n VectorOpenDataStandardDark – Open Data Standard Dark is a\n dark-themed map style that provides a detailed basemap for the world \n suitable for website and mobile application use. The map includes highways \n major roads, minor roads, railways, water features, cities, parks, \n landmarks, building footprints, and administrative boundaries.

    \n
    • \n
  • \n

    \n VectorOpenDataVisualizationLight – The Open Data \n Visualization Light map style is a light-themed style with muted colors and\n fewer features that aids in understanding overlaid data.

    \n
    • \n
  • \n

    \n VectorOpenDataVisualizationDark – The Open Data \n Visualization Dark map style is a dark-themed style with muted colors and\n fewer features that aids in understanding overlaid data.

    \n
    • \n
", + "smithy.api#documentation": "

Specifies the map style selected from an available data provider.

\n

Valid Esri map styles:

\n
    \n
  • \n

    \n VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A\n vector basemap with a dark gray, neutral background with minimal colors, labels,\n and features that's designed to draw attention to your thematic content.

    \n
    • \n
  • \n

    \n RasterEsriImagery – The Esri Imagery map style. A raster basemap\n that provides one meter or better satellite and aerial imagery in many parts of\n the world and lower resolution satellite imagery worldwide.

    \n
    • \n
  • \n

    \n VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style,\n which provides a detailed vector basemap with a light gray, neutral background\n style with minimal colors, labels, and features that's designed to draw\n attention to your thematic content.

    \n
    • \n
  • \n

    \n VectorEsriTopographic – The Esri Light map style, which provides\n a detailed vector basemap with a classic Esri map style.

    \n
    • \n
  • \n

    \n VectorEsriStreets – The Esri Street Map style, which\n provides a detailed vector basemap for the world symbolized with a classic Esri\n street map style. The vector tile layer is similar in content and style to the\n World Street Map raster map.

    \n
    • \n
  • \n

    \n VectorEsriNavigation – The Esri Navigation map style, which\n provides a detailed basemap for the world symbolized with a custom navigation\n map style that's designed for use during the day in mobile devices.

    \n
    • \n
\n

Valid HERE\n Technologies map styles:

\n
    \n
  • \n

    \n VectorHereContrast – The HERE Contrast (Berlin) map style is a \n high contrast\n detailed base map of the world that blends 3D and 2D rendering.

    \n \n

    The VectorHereContrast style has been renamed from \n VectorHereBerlin. \n VectorHereBerlin has been deprecated, but will continue to work in \n applications that use it.

    \n     \n
    • \n
  • \n

    \n VectorHereExplore – A default HERE map style containing a \n neutral, global map and its features including roads, buildings, landmarks, \n and water features. It also now includes a fully designed map of Japan.

    \n
    • \n
  • \n

    \n VectorHereExploreTruck – A global map containing truck \n restrictions and attributes (e.g. width / height / HAZMAT) symbolized with \n highlighted segments and icons on top of HERE Explore to support use cases \n within transport and logistics.

    \n
    • \n
  • \n

    \n RasterHereExploreSatellite – A global map containing high\n resolution satellite imagery.

    \n
    • \n
  • \n

    \n HybridHereExploreSatellite – A global map displaying the road \n network, street names, and city labels over satellite imagery. This style \n will automatically retrieve both raster and vector tiles, and your charges \n will be based on total tiles retrieved.

    \n \n

    Hybrid styles use both vector and raster tiles when rendering the \n map that you see. This means that more tiles are retrieved than when using \n either vector or raster tiles alone. Your charges will include all tiles \n retrieved.

    \n     \n
    • \n
\n

Valid GrabMaps map styles:

\n
    \n
  • \n

    \n VectorGrabStandardLight – The Grab Standard Light \n map style provides a basemap with detailed land use coloring, \n area names, roads, landmarks, and points of interest covering \n Southeast Asia.

    \n
    • \n
  • \n

    \n VectorGrabStandardDark – The Grab Standard Dark \n map style provides a dark variation of the standard basemap \n covering Southeast Asia.

    \n
    • \n
\n \n

Grab provides maps only for countries in Southeast Asia, and is only available \n in the Asia Pacific (Singapore) Region (ap-southeast-1).\n For more information, see GrabMaps countries and area covered.

\n \n

Valid Open Data map styles:

\n
    \n
  • \n

    \n VectorOpenDataStandardLight – The Open Data Standard Light \n map style provides a detailed basemap for the world suitable for\n website and mobile application use. The map includes highways major roads, \n minor roads, railways, water features, cities, parks, landmarks, building\n footprints, and administrative boundaries.

    \n
    • \n
  • \n

    \n VectorOpenDataStandardDark – Open Data Standard Dark is a\n dark-themed map style that provides a detailed basemap for the world \n suitable for website and mobile application use. The map includes highways \n major roads, minor roads, railways, water features, cities, parks, \n landmarks, building footprints, and administrative boundaries.

    \n
    • \n
  • \n

    \n VectorOpenDataVisualizationLight – The Open Data \n Visualization Light map style is a light-themed style with muted colors and\n fewer features that aids in understanding overlaid data.

    \n
    • \n
  • \n

    \n VectorOpenDataVisualizationDark – The Open Data \n Visualization Dark map style is a dark-themed style with muted colors and\n fewer features that aids in understanding overlaid data.

    \n
    • \n
", "smithy.api#required": {} } }, "PoliticalView": { "target": "com.amazonaws.location#CountryCode3", "traits": { - "smithy.api#documentation": "

Specifies the political view for the style. Leave unset to not use a political \n view, or, for styles that support specific political views, you can choose a view, \n such as IND for the Indian view.

\n

Default is unset.

\n \n

Not all map resources or styles support political view styles. See \n Political \n views \n for more information.

\n " + "smithy.api#documentation": "

Specifies the political view for the style. Leave unset to not use a political \n view, or, for styles that support specific political views, you can choose a view, \n such as IND for the Indian view.

\n

Default is unset.

\n \n

Not all map resources or styles support political view styles. See \n Political \n views \n for more information.

\n " } }, "CustomLayers": { @@ -7197,7 +7213,7 @@ "PoliticalView": { "target": "com.amazonaws.location#CountryCode3OrEmpty", "traits": { - "smithy.api#documentation": "

Specifies the political view for the style. Set to an empty string to not use a\n political view, or, for styles that support specific political views, you can choose a \n view, such as IND for the Indian view.

\n \n

Not all map resources or styles support political view styles. See \n Political \n views \n for more information.

\n " + "smithy.api#documentation": "

Specifies the political view for the style. Set to an empty string to not use a\n political view, or, for styles that support specific political views, you can choose a \n view, such as IND for the Indian view.

\n \n

Not all map resources or styles support political view styles. See \n Political \n views \n for more information.

\n " } }, "CustomLayers": { @@ -7267,6 +7283,17 @@ "smithy.api#pattern": "^[-._\\w]+$" } }, + "com.amazonaws.location#MultiLinearRings": { + "type": "list", + "member": { + "target": "com.amazonaws.location#LinearRings" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.location#NearestDistance": { "type": "double", "traits": { @@ -7389,7 +7416,7 @@ "Categories": { "target": "com.amazonaws.location#PlaceCategoryList", "traits": { - "smithy.api#documentation": "

The Amazon Location categories that describe this Place.

\n

For more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service Developer \n Guide.

" + "smithy.api#documentation": "

The Amazon Location categories that describe this Place.

\n

For more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service developer \n guide.

" } }, "SupplementalCategories": { @@ -7594,7 +7621,7 @@ "type": "structure", "members": { "Horizontal": { - "target": "smithy.api#Double", + "target": "com.amazonaws.location#SensitiveDouble", "traits": { "smithy.api#documentation": "

Estimated maximum distance, in meters, between the measured position and the true\n position of a device, along the Earth's surface.

", "smithy.api#range": { @@ -7718,14 +7745,14 @@ "Geometry": { "target": "com.amazonaws.location#GeofenceGeometry", "traits": { - "smithy.api#documentation": "

Contains the details to specify the position of the geofence. Can be a\n polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

\n \n

The \n geofence polygon format supports a maximum of 1,000 vertices. The Geofence Geobuf format supports a maximum of 100,000 vertices.

\n ", + "smithy.api#documentation": "

Contains the details to specify the position of the geofence. Can be a circle, a\n polygon, or a multipolygon. Polygon and MultiPolygon\n geometries can be defined using their respective parameters, or encoded in Geobuf format\n using the Geobuf parameter. Including multiple geometry types in the same\n request will return a validation error.

\n \n

The geofence Polygon and MultiPolygon formats support a\n maximum of 1,000 total vertices. The Geobuf format supports a maximum\n of 100,000 vertices.

\n ", "smithy.api#required": {} } }, "GeofenceProperties": { "target": "com.amazonaws.location#PropertyMap", "traits": { - "smithy.api#documentation": "

Associates one of more properties with the geofence. A property is a key-value\n pair stored with the geofence and added to any geofence event triggered with that\n geofence.

\n

Format: \"key\" : \"value\"\n

" + "smithy.api#documentation": "

Associates one of more properties with the geofence. A property is a key-value pair\n stored with the geofence and added to any geofence event triggered with that\n geofence.

\n

Format: \"key\" : \"value\"\n

" } } } @@ -7762,7 +7789,8 @@ "smithy.api#length": { "max": 253 }, - "smithy.api#pattern": "^([$\\-._+!*\\x{60}(),;/?:@=&\\w]|%([0-9a-fA-F?]{2}|[0-9a-fA-F?]?[*]))+$" + "smithy.api#pattern": "^([$\\-._+!*\\x{60}(),;/?:@=&\\w]|%([0-9a-fA-F?]{2}|[0-9a-fA-F?]?[*]))+$", + "smithy.api#sensitive": {} } }, "com.amazonaws.location#RefererPatternList": { @@ -8011,7 +8039,7 @@ "Categories": { "target": "com.amazonaws.location#PlaceCategoryList", "traits": { - "smithy.api#documentation": "

The Amazon Location categories that describe the Place.

\n

For more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service Developer \n Guide.

" + "smithy.api#documentation": "

The Amazon Location categories that describe the Place.

\n

For more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service developer \n guide.

" } }, "SupplementalCategories": { @@ -8147,7 +8175,7 @@ "Key": { "target": "com.amazonaws.location#ApiKey", "traits": { - "smithy.api#documentation": "

The optional API key to authorize \n the request.

", + "smithy.api#documentation": "

The optional API key to authorize \n the request.

", "smithy.api#httpQuery": "key" } } @@ -8191,7 +8219,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The geospatial data provider attached to the place index resource specified in the\n request. Values can be one of the following:

\n
    \n
  • \n

    Esri

    \n
    • \n
  • \n

    Grab

    \n
    • \n
  • \n

    Here

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", + "smithy.api#documentation": "

The geospatial data provider attached to the place index resource specified in the\n request. Values can be one of the following:

\n
    \n
  • \n

    Esri

    \n
    • \n
  • \n

    Grab

    \n
    • \n
  • \n

    Here

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, @@ -8303,13 +8331,13 @@ "FilterCategories": { "target": "com.amazonaws.location#FilterPlaceCategoryList", "traits": { - "smithy.api#documentation": "

A list of one or more Amazon Location categories to filter the returned places. If you \n include more than one category, the results will include results that match \n any of the categories listed.

\n

For more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service Developer \n Guide.

" + "smithy.api#documentation": "

A list of one or more Amazon Location categories to filter the returned places. If you \n include more than one category, the results will include results that match \n any of the categories listed.

\n

For more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service developer \n guide.

" } }, "Key": { "target": "com.amazonaws.location#ApiKey", "traits": { - "smithy.api#documentation": "

The optional API key to authorize \n the request.

", + "smithy.api#documentation": "

The optional API key to authorize \n the request.

", "smithy.api#httpQuery": "key" } } @@ -8371,7 +8399,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The geospatial data provider attached to the place index resource specified in the\n request. Values can be one of the following:

\n
    \n
  • \n

    Esri

    \n
    • \n
  • \n

    Grab

    \n
    • \n
  • \n

    Here

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", + "smithy.api#documentation": "

The geospatial data provider attached to the place index resource specified in the\n request. Values can be one of the following:

\n
    \n
  • \n

    Esri

    \n
    • \n
  • \n

    Grab

    \n
    • \n
  • \n

    Here

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, @@ -8484,13 +8512,13 @@ "FilterCategories": { "target": "com.amazonaws.location#FilterPlaceCategoryList", "traits": { - "smithy.api#documentation": "

A list of one or more Amazon Location categories to filter the returned places. If you \n include more than one category, the results will include results that match \n any of the categories listed.

\n

For more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service Developer \n Guide.

" + "smithy.api#documentation": "

A list of one or more Amazon Location categories to filter the returned places. If you \n include more than one category, the results will include results that match \n any of the categories listed.

\n

For more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service developer \n guide.

" } }, "Key": { "target": "com.amazonaws.location#ApiKey", "traits": { - "smithy.api#documentation": "

The optional API key to authorize \n the request.

", + "smithy.api#documentation": "

The optional API key to authorize \n the request.

", "smithy.api#httpQuery": "key" } } @@ -8558,7 +8586,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The geospatial data provider attached to the place index resource specified in the\n request. Values can be one of the following:

\n
    \n
  • \n

    Esri

    \n
    • \n
  • \n

    Grab

    \n
    • \n
  • \n

    Here

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", + "smithy.api#documentation": "

The geospatial data provider attached to the place index resource specified in the\n request. Values can be one of the following:

\n
    \n
  • \n

    Esri

    \n
    • \n
  • \n

    Grab

    \n
    • \n
  • \n

    Here

    \n
    • \n
\n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, @@ -8579,6 +8607,12 @@ "smithy.api#documentation": "

A summary of the request sent by using SearchPlaceIndexForText.

" } }, + "com.amazonaws.location#SensitiveDouble": { + "type": "double", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.location#SensitiveString": { "type": "string", "traits": { @@ -8598,7 +8632,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation was denied because the request would exceed the maximum quota\n set for Amazon Location Service.

", + "smithy.api#documentation": "

The operation was denied because the request would exceed the maximum quota\n set for Amazon Location Service.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -8837,6 +8871,7 @@ "com.amazonaws.location#Timestamp": { "type": "timestamp", "traits": { + "smithy.api#sensitive": {}, "smithy.api#timestampFormat": "date-time" } }, @@ -9837,7 +9872,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.

", + "smithy.api#documentation": "

Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.

\n \n

The Location Integrity SDK provides enhanced \n features related to device verification, and it is available for use by request. \n To get access to the SDK, contact Sales Support.

\n ", "smithy.api#endpoint": { "hostPrefix": "tracking." }, diff --git a/codegen/sdk/aws-models/mailmanager.json b/codegen/sdk/aws-models/mailmanager.json index 5a2098b8949..6f0788673dc 100644 --- a/codegen/sdk/aws-models/mailmanager.json +++ b/codegen/sdk/aws-models/mailmanager.json @@ -1380,12 +1380,6 @@ "smithy.api#documentation": "

Specifies the network configuration for the ingress point. This allows you to create an IPv4-only, Dual-Stack, or PrivateLink type of ingress point. If not specified, the default network type is IPv4-only.

" } }, - "NetworkConfiguration": { - "target": "com.amazonaws.mailmanager#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies the network configuration for the ingress point.\n This allows you to create an IPv4-only, Dual-Stack, or PrivateLink type of ingress point. If not specified, the default network type is IPv4-only.\n

" - } - }, "Tags": { "target": "com.amazonaws.mailmanager#TagList", "traits": { @@ -2206,7 +2200,7 @@ "min": 0, "max": 254 }, - "smithy.api#pattern": "^[0-9A-Za-z@+.-]+$", + "smithy.api#pattern": "^[a-zA-Z0-9._+-]+@[a-zA-Z0-9.-]+$", "smithy.api#sensitive": {} } }, @@ -4143,60 +4137,6 @@ "smithy.api#documentation": "

The structure for an IPv6 based condition matching on the incoming mail.

" } }, - "com.amazonaws.mailmanager#IngressIpv6Attribute": { - "type": "enum", - "members": { - "SENDER_IPV6": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SENDER_IPV6" - } - } - } - }, - "com.amazonaws.mailmanager#IngressIpv6Expression": { - "type": "structure", - "members": { - "Evaluate": { - "target": "com.amazonaws.mailmanager#IngressIpv6ToEvaluate", - "traits": { - "smithy.api#documentation": "

The left hand side argument of an IPv6 condition expression.

", - "smithy.api#required": {} - } - }, - "Operator": { - "target": "com.amazonaws.mailmanager#IngressIpOperator", - "traits": { - "smithy.api#documentation": "

The matching operator for an IPv6 condition expression.

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.mailmanager#Ipv6Cidrs", - "traits": { - "smithy.api#documentation": "

The right hand side argument of an IPv6 condition expression.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The union type representing the allowed types for the left hand side of an IPv6 condition.

" - } - }, - "com.amazonaws.mailmanager#IngressIpv6ToEvaluate": { - "type": "union", - "members": { - "Attribute": { - "target": "com.amazonaws.mailmanager#IngressIpv6Attribute", - "traits": { - "smithy.api#documentation": "

An enum type representing the allowed attribute types for an IPv6 condition.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The structure for an IPv6 based condition matching on the incoming mail.

" - } - }, "com.amazonaws.mailmanager#IngressIsInAddressList": { "type": "structure", "members": { @@ -4664,23 +4604,6 @@ } } }, - "com.amazonaws.mailmanager#IpType": { - "type": "enum", - "members": { - "IPV4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IPV4" - } - }, - "DUAL_STACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DUAL_STACK" - } - } - } - }, "com.amazonaws.mailmanager#Ipv4Cidr": { "type": "string", "traits": { @@ -6758,12 +6681,6 @@ "smithy.api#documentation": "

This represents an IPv6 based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

" } }, - "Ipv6Expression": { - "target": "com.amazonaws.mailmanager#IngressIpv6Expression", - "traits": { - "smithy.api#documentation": "

This represents an IPv6 based condition matching on the incoming mail. It performs the\n operation configured in 'Operator' and evaluates the 'Protocol' object against the\n 'Value'.

" - } - }, "TlsExpression": { "target": "com.amazonaws.mailmanager#IngressTlsProtocolExpression", "traits": { diff --git a/codegen/sdk/aws-models/mediaconvert.json b/codegen/sdk/aws-models/mediaconvert.json index 022b3c34faa..75b715fd784 100644 --- a/codegen/sdk/aws-models/mediaconvert.json +++ b/codegen/sdk/aws-models/mediaconvert.json @@ -69,6 +69,12 @@ "traits": { "smithy.api#enumValue": "HEV2" } + }, + "XHE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XHE" + } } }, "traits": { @@ -113,6 +119,26 @@ "smithy.api#documentation": "The Coding mode that you specify determines the number of audio channels and the audio channel layout metadata in your AAC output. Valid coding modes depend on the Rate control mode and Profile that you select. The following list shows the number of audio channels and channel layout for each coding mode. * 1.0 Audio Description (Receiver Mix): One channel, C. Includes audio description data from your stereo input. For more information see ETSI TS 101 154 Annex E. * 1.0 Mono: One channel, C. * 2.0 Stereo: Two channels, L, R. * 5.1 Surround: Six channels, C, L, R, Ls, Rs, LFE." } }, + "com.amazonaws.mediaconvert#AacLoudnessMeasurementMode": { + "type": "enum", + "members": { + "PROGRAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM" + } + }, + "ANCHOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANCHOR" + } + } + }, + "traits": { + "smithy.api#documentation": "Choose the loudness measurement mode for your audio content. For music or advertisements: We recommend that you keep the default value, Program. For speech or other content: We recommend that you choose Anchor. When you do, MediaConvert optimizes the loudness of your output for clarify by applying speech gates." + } + }, "com.amazonaws.mediaconvert#AacRateControlMode": { "type": "enum", "members": { @@ -184,6 +210,20 @@ "smithy.api#jsonName": "codingMode" } }, + "LoudnessMeasurementMode": { + "target": "com.amazonaws.mediaconvert#AacLoudnessMeasurementMode", + "traits": { + "smithy.api#documentation": "Choose the loudness measurement mode for your audio content. For music or advertisements: We recommend that you keep the default value, Program. For speech or other content: We recommend that you choose Anchor. When you do, MediaConvert optimizes the loudness of your output for clarify by applying speech gates.", + "smithy.api#jsonName": "loudnessMeasurementMode" + } + }, + "RapInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin2000Max30000", + "traits": { + "smithy.api#documentation": "Specify the RAP (Random Access Point) interval for your xHE-AAC audio output. A RAP allows a decoder to decode audio data mid-stream, without the need to reference previous audio frames, and perform adaptive audio bitrate switching. To specify the RAP interval: Enter an integer from 2000 to 30000, in milliseconds. Smaller values allow for better seeking and more frequent stream switching, while large values improve compression efficiency. To have MediaConvert automatically determine the RAP interval: Leave blank.", + "smithy.api#jsonName": "rapInterval" + } + }, "RateControlMode": { "target": "com.amazonaws.mediaconvert#AacRateControlMode", "traits": { @@ -212,6 +252,13 @@ "smithy.api#jsonName": "specification" } }, + "TargetLoudnessRange": { + "target": "com.amazonaws.mediaconvert#__integerMin6Max16", + "traits": { + "smithy.api#documentation": "Specify the xHE-AAC loudness target. Enter an integer from 6 to 16, representing \"loudness units\". For more information, see the following specification: Supplementary information for R 128 EBU Tech 3342-2023.", + "smithy.api#jsonName": "targetLoudnessRange" + } + }, "VbrQuality": { "target": "com.amazonaws.mediaconvert#AacVbrQuality", "traits": { @@ -5035,6 +5082,12 @@ "smithy.api#enumValue": "HEVC" } }, + "JPEG2000": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JPEG2000" + } + }, "MJPEG": { "target": "smithy.api#Unit", "traits": { @@ -5524,7 +5577,7 @@ "Format": { "target": "com.amazonaws.mediaconvert#Format", "traits": { - "smithy.api#documentation": "The format of your media file. For example: MP4, QuickTime (MOV), Matroska (MKV), or WebM. Note that this will be blank if your media file has a format that the MediaConvert Probe operation does not recognize.", + "smithy.api#documentation": "The format of your media file. For example: MP4, QuickTime (MOV), Matroska (MKV), WebM or MXF. Note that this will be blank if your media file has a format that the MediaConvert Probe operation does not recognize.", "smithy.api#jsonName": "format" } }, @@ -9598,7 +9651,7 @@ } }, "SampleRate": { - "target": "com.amazonaws.mediaconvert#__integerMin22050Max48000", + "target": "com.amazonaws.mediaconvert#__integerMin22050Max192000", "traits": { "smithy.api#documentation": "Sample rate in Hz.", "smithy.api#jsonName": "sampleRate" @@ -9699,6 +9752,12 @@ "traits": { "smithy.api#enumValue": "webm" } + }, + "mxf": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mxf" + } } } }, @@ -13833,7 +13892,7 @@ "FileInput": { "target": "com.amazonaws.mediaconvert#__stringMax2048PatternS3Https", "traits": { - "smithy.api#documentation": "Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, \"s3://bucket/vf/cpl.xml\". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* to specify any supplemental IMPs that contain assets referenced by the CPL.", + "smithy.api#documentation": "Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. For standard inputs, provide the path to your S3, HTTP, or HTTPS source file. For example, s3://amzn-s3-demo-bucket/input.mp4 for an Amazon S3 input or https://example.com/input.mp4 for an HTTPS input. For TAMS inputs, specify the HTTPS endpoint of your TAMS server. For example, https://tams-server.example.com . When you do, also specify Source ID, Timerange, GAP handling, and the Authorization connection ARN under TAMS settings. (Don't include these parameters in the Input file URL.) For IMF inputs, specify your input by providing the path to your CPL. For example, s3://amzn-s3-demo-bucket/vf/cpl.xml . If the CPL is in an incomplete IMP, make sure to use Supplemental IMPsto specify any supplemental IMPs that contain assets referenced by the CPL.", "smithy.api#jsonName": "fileInput" } }, @@ -13900,6 +13959,13 @@ "smithy.api#jsonName": "supplementalImps" } }, + "TamsSettings": { + "target": "com.amazonaws.mediaconvert#InputTamsSettings", + "traits": { + "smithy.api#documentation": "Specify a Time Addressable Media Store (TAMS) server as an input source. TAMS is an open-source API specification that provides access to time-segmented media content. Use TAMS to retrieve specific time ranges from live or archived media streams. When you specify TAMS settings, MediaConvert connects to your TAMS server, retrieves the media segments for your specified time range, and processes them as a single input. This enables workflows like extracting clips from live streams or processing specific portions of archived content. To use TAMS, you must: 1. Have access to a TAMS-compliant server 2. Specify the server URL in the Input file URL field 3. Provide the required SourceId and Timerange parameters 4. Configure authentication, if your TAMS server requires it", + "smithy.api#jsonName": "tamsSettings" + } + }, "TimecodeSource": { "target": "com.amazonaws.mediaconvert#InputTimecodeSource", "traits": { @@ -14188,6 +14254,42 @@ "smithy.api#documentation": "When you have a progressive segmented frame (PsF) input, use this setting to flag the input as PsF. MediaConvert doesn't automatically detect PsF. Therefore, flagging your input as PsF results in better preservation of video quality when you do deinterlacing and frame rate conversion. If you don't specify, the default value is Auto. Auto is the correct setting for all inputs that are not PsF. Don't set this value to PsF when your input is interlaced. Doing so creates horizontal interlacing artifacts." } }, + "com.amazonaws.mediaconvert#InputTamsSettings": { + "type": "structure", + "members": { + "AuthConnectionArn": { + "target": "com.amazonaws.mediaconvert#__stringPatternArnAwsAZ09EventsAZ090912ConnectionAZAZ09AF0936", + "traits": { + "smithy.api#documentation": "Specify the ARN (Amazon Resource Name) of an EventBridge Connection to authenticate with your TAMS server. The EventBridge Connection stores your authentication credentials securely. MediaConvert assumes your job's IAM role to access this connection, so ensure the role has the events:RetrieveConnectionCredentials, secretsmanager:DescribeSecret, and secretsmanager:GetSecretValue permissions. Format: arn:aws:events:region:account-id:connection/connection-name/unique-id", + "smithy.api#jsonName": "authConnectionArn" + } + }, + "GapHandling": { + "target": "com.amazonaws.mediaconvert#TamsGapHandling", + "traits": { + "smithy.api#documentation": "Specify how MediaConvert handles gaps between media segments in your TAMS source. Gaps can occur in live streams due to network issues or other interruptions. Choose from the following options: * Skip gaps - Default. Skip over gaps and join segments together. This creates a continuous output with no blank frames, but may cause timeline discontinuities. * Fill with black - Insert black frames to fill gaps between segments. This maintains timeline continuity but adds black frames where content is missing. * Hold last frame - Repeat the last frame before a gap until the next segment begins. This maintains visual continuity during gaps.", + "smithy.api#jsonName": "gapHandling" + } + }, + "SourceId": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Specify the unique identifier for the media source in your TAMS server. MediaConvert uses this source ID to locate the appropriate flows containing the media segments you want to process. The source ID corresponds to a specific media source registered in your TAMS server. This source must be of type urn:x-nmos:format:multi, and can can reference multiple flows for audio, video, or combined audio/video content. MediaConvert automatically selects the highest quality flows available for your job. This setting is required when include TAMS settings in your job.", + "smithy.api#jsonName": "sourceId" + } + }, + "Timerange": { + "target": "com.amazonaws.mediaconvert#__stringPattern019090190908019090190908", + "traits": { + "smithy.api#documentation": "Specify the time range of media segments to retrieve from your TAMS server. MediaConvert fetches only the segments that fall within this range. Use the format specified by your TAMS server implementation. This must be two timestamp values with the format {sign?}{seconds}:{nanoseconds}, separated by an underscore, surrounded by either parentheses or square brackets. Example: [15:0_35:0) This setting is required when include TAMS settings in your job.", + "smithy.api#jsonName": "timerange" + } + } + }, + "traits": { + "smithy.api#documentation": "Specify a Time Addressable Media Store (TAMS) server as an input source. TAMS is an open-source API specification that provides access to time-segmented media content. Use TAMS to retrieve specific time ranges from live or archived media streams. When you specify TAMS settings, MediaConvert connects to your TAMS server, retrieves the media segments for your specified time range, and processes them as a single input. This enables workflows like extracting clips from live streams or processing specific portions of archived content. To use TAMS, you must: 1. Have access to a TAMS-compliant server 2. Specify the server URL in the Input file URL field 3. Provide the required SourceId and Timerange parameters 4. Configure authentication, if your TAMS server requires it" + } + }, "com.amazonaws.mediaconvert#InputTemplate": { "type": "structure", "members": { @@ -23965,6 +24067,32 @@ "smithy.api#output": {} } }, + "com.amazonaws.mediaconvert#TamsGapHandling": { + "type": "enum", + "members": { + "SKIP_GAPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIP_GAPS" + } + }, + "FILL_WITH_BLACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILL_WITH_BLACK" + } + }, + "HOLD_LAST_FRAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOLD_LAST_FRAME" + } + } + }, + "traits": { + "smithy.api#documentation": "Specify how MediaConvert handles gaps between media segments in your TAMS source. Gaps can occur in live streams due to network issues or other interruptions. Choose from the following options: * Skip gaps - Default. Skip over gaps and join segments together. This creates a continuous output with no blank frames, but may cause timeline discontinuities. * Fill with black - Insert black frames to fill gaps between segments. This maintains timeline continuity but adds black frames where content is missing. * Hold last frame - Repeat the last frame before a gap until the next segment begins. This maintains visual continuity during gaps." + } + }, "com.amazonaws.mediaconvert#TeletextDestinationSettings": { "type": "structure", "members": { @@ -25583,7 +25711,7 @@ "Codec": { "target": "com.amazonaws.mediaconvert#VideoCodec", "traits": { - "smithy.api#documentation": "Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec. To passthrough the video stream of your input JPEG2000, VC-3, AVC-INTRA or Apple ProRes video without any video encoding: Choose Passthrough. If you have multiple input videos, note that they must have identical encoding attributes. When you choose Passthrough, your output container must be MXF or QuickTime MOV.", + "smithy.api#documentation": "Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec. To passthrough the video stream of your input without any video encoding: Choose Passthrough. More information about passthrough codec support and job settings requirements, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/video-passthrough-feature-restrictions.html", "smithy.api#jsonName": "codec" } }, @@ -25881,7 +26009,7 @@ "Height": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Specify the height of the video overlay cropping rectangle. To use the same height as your overlay input video: Keep blank, or enter 0. To specify a different height for the cropping rectangle: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 100 and choose Pixels, the cropping rectangle will 100 pixels high. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be 108 pixels high.", + "smithy.api#documentation": "Specify the height of the video overlay cropping rectangle. To use the same height as your overlay input video: Keep blank, or enter 0. To specify a different height for the cropping rectangle: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 100 and choose Pixels, the cropping rectangle will be 100 pixels high. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be 108 pixels high.", "smithy.api#jsonName": "height" } }, @@ -25895,7 +26023,7 @@ "Width": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Specify the width of the video overlay cropping rectangle. To use the same width as your overlay input video: Keep blank, or enter 0. To specify a different width for the cropping rectangle: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 100 and choose Pixels, the cropping rectangle will 100 pixels wide. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be 192 pixels wide.", + "smithy.api#documentation": "Specify the width of the video overlay cropping rectangle. To use the same width as your overlay input video: Keep blank, or enter 0. To specify a different width for the cropping rectangle: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 100 and choose Pixels, the cropping rectangle will be 100 pixels wide. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be 192 pixels wide.", "smithy.api#jsonName": "width" } }, @@ -28434,6 +28562,24 @@ } } }, + "com.amazonaws.mediaconvert#__integerMin2000Max30000": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 2000, + "max": 30000 + } + } + }, + "com.amazonaws.mediaconvert#__integerMin22050Max192000": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 22050, + "max": 192000 + } + } + }, "com.amazonaws.mediaconvert#__integerMin22050Max48000": { "type": "integer", "traits": { @@ -28605,6 +28751,15 @@ } } }, + "com.amazonaws.mediaconvert#__integerMin6Max16": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 6, + "max": 16 + } + } + }, "com.amazonaws.mediaconvert#__integerMin8000Max192000": { "type": "integer", "traits": { @@ -29425,6 +29580,12 @@ "smithy.api#pattern": "^([01][0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9][:;][0-9]{2}(@[0-9]+(\\.[0-9]+)?(:[0-9]+)?)?$" } }, + "com.amazonaws.mediaconvert#__stringPattern019090190908019090190908": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(\\[|\\()?(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?(_(-?(0|[1-9][0-9]*):(0|[1-9][0-9]{0,8}))?)?(\\]|\\))?$" + } + }, "com.amazonaws.mediaconvert#__stringPattern01D20305D205D": { "type": "string", "traits": { @@ -29473,6 +29634,12 @@ "smithy.api#pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9-]+)?$" } }, + "com.amazonaws.mediaconvert#__stringPatternArnAwsAZ09EventsAZ090912ConnectionAZAZ09AF0936": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-z0-9-]*:events:[a-z0-9-]+:[0-9]{12}:connection/[a-zA-Z0-9-]+/[a-f0-9-]{36}$" + } + }, "com.amazonaws.mediaconvert#__stringPatternArnAwsUsGovAcm": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/mediapackagev2.json b/codegen/sdk/aws-models/mediapackagev2.json index 1899cf200f7..96d629b7976 100644 --- a/codegen/sdk/aws-models/mediapackagev2.json +++ b/codegen/sdk/aws-models/mediapackagev2.json @@ -3622,7 +3622,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to retrieve details of a channel in a channel group", - "smithy.api#documentation": "

Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

", + "smithy.api#documentation": "

Retrieves the specified channel that's configured in AWS Elemental MediaPackage.

", "smithy.api#examples": [ { "title": "Getting a Channel", @@ -3690,7 +3690,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to retrieve details of a channel group", - "smithy.api#documentation": "

Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.

", + "smithy.api#documentation": "

Retrieves the specified channel group that's configured in AWS Elemental MediaPackage.

", "smithy.api#examples": [ { "title": "Getting a Channel Group", @@ -5436,6 +5436,16 @@ "traits": { "smithy.api#documentation": "

When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is true. This setting is valid only when InputType is CMAF.

" } + }, + "PreferredInput": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select 1 to prefer the first ingest endpoint, or 2 to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal.

", + "smithy.api#range": { + "min": 1, + "max": 2 + } + } } }, "traits": { @@ -5615,7 +5625,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list all channels in a channel group", - "smithy.api#documentation": "

Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

", + "smithy.api#documentation": "

Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage.

", "smithy.api#examples": [ { "title": "Listing all Channels", @@ -9222,6 +9232,12 @@ "smithy.api#enumValue": "ONLY_CMAF_INPUT_TYPE_ALLOW_MQCS_OUTPUT_CONFIGURATION" } }, + "ONLY_CMAF_INPUT_TYPE_ALLOW_PREFERRED_INPUT_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONLY_CMAF_INPUT_TYPE_ALLOW_PREFERRED_INPUT_CONFIGURATION" + } + }, "TS_CONTAINER_TYPE_WITH_MSS_MANIFEST": { "target": "smithy.api#Unit", "traits": { diff --git a/codegen/sdk/aws-models/neptunedata.json b/codegen/sdk/aws-models/neptunedata.json index 50f74535e71..1b45523f70b 100644 --- a/codegen/sdk/aws-models/neptunedata.json +++ b/codegen/sdk/aws-models/neptunedata.json @@ -192,7 +192,7 @@ "name": "neptune-db" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Neptune Data API\n

The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data\n operations, including data loading, query execution, data inquiry, and machine learning.\n It supports the Gremlin and openCypher query languages, and is\n available in all SDK languages. It automatically signs API requests and greatly simplifies\n integrating Neptune into your applications.

", + "smithy.api#documentation": "Neptune Data API

The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data operations, including data loading, query execution, data inquiry, and machine learning. It supports the Gremlin and openCypher query languages, and is available in all SDK languages. It automatically signs API requests and greatly simplifies integrating Neptune into your applications.

", "smithy.api#externalDocumentation": { "API Reference": "https://docs.aws.amazon.com/neptune/latest/userguide/intro.html" }, @@ -979,7 +979,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a Gremlin query. See Gremlin\n query cancellation for more information.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:CancelQuery\n IAM action in that cluster.

", + "smithy.api#documentation": "

Cancels a Gremlin query. See Gremlin query cancellation for more information.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelQuery IAM action in that cluster.

", "smithy.api#http": { "method": "DELETE", "uri": "/gremlin/status/{queryId}", @@ -1068,7 +1068,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a specified load job. This is an HTTP DELETE\n request. See Neptune\n Loader Get-Status API for more information.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:CancelLoaderJob\n IAM action in that cluster..

", + "smithy.api#documentation": "

Cancels a specified load job. This is an HTTP DELETE request. See Neptune Loader Get-Status API for more information.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelLoaderJob IAM action in that cluster..

", "smithy.api#http": { "method": "DELETE", "uri": "/loader/{loadId}", @@ -1151,7 +1151,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a Neptune ML data processing job. See The\n dataprocessing command.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:CancelMLDataProcessingJob\n IAM action in that cluster.

", + "smithy.api#documentation": "

Cancels a Neptune ML data processing job. See The dataprocessing command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelMLDataProcessingJob IAM action in that cluster.

", "smithy.api#http": { "method": "DELETE", "uri": "/ml/dataprocessing/{id}", @@ -1174,14 +1174,14 @@ "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

", "smithy.api#httpQuery": "neptuneIamRoleArn" } }, "clean": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

If set to TRUE, this flag specifies that all\n Neptune ML S3 artifacts should be deleted when the job is stopped.\n The default is FALSE.

", + "smithy.api#documentation": "

If set to TRUE, this flag specifies that all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is FALSE.

", "smithy.api#httpQuery": "clean" } } @@ -1248,7 +1248,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a Neptune ML model training job. See Model\n training using the modeltraining command.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:CancelMLModelTrainingJob\n IAM action in that cluster.

", + "smithy.api#documentation": "

Cancels a Neptune ML model training job. See Model training using the modeltraining command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelMLModelTrainingJob IAM action in that cluster.

", "smithy.api#http": { "method": "DELETE", "uri": "/ml/modeltraining/{id}", @@ -1271,14 +1271,14 @@ "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

", "smithy.api#httpQuery": "neptuneIamRoleArn" } }, "clean": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

If set to TRUE, this flag specifies that all\n Amazon S3 artifacts should be deleted when the job is stopped.\n The default is FALSE.

", + "smithy.api#documentation": "

If set to TRUE, this flag specifies that all Amazon S3 artifacts should be deleted when the job is stopped. The default is FALSE.

", "smithy.api#httpQuery": "clean" } } @@ -1345,7 +1345,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a specified model transform job. See Use\n a trained model to generate new model artifacts.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:CancelMLModelTransformJob\n IAM action in that cluster.

", + "smithy.api#documentation": "

Cancels a specified model transform job. See Use a trained model to generate new model artifacts.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelMLModelTransformJob IAM action in that cluster.

", "smithy.api#http": { "method": "DELETE", "uri": "/ml/modeltransform/{id}", @@ -1368,14 +1368,14 @@ "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

", "smithy.api#httpQuery": "neptuneIamRoleArn" } }, "clean": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

If this flag is set to TRUE, all Neptune ML S3 artifacts\n should be deleted when the job is stopped. The default is FALSE.

", + "smithy.api#documentation": "

If this flag is set to TRUE, all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is FALSE.

", "smithy.api#httpQuery": "clean" } } @@ -1454,7 +1454,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a specified openCypher query. See Neptune\n openCypher status endpoint for more information.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:CancelQuery\n IAM action in that cluster.

", + "smithy.api#documentation": "

Cancels a specified openCypher query. See Neptune openCypher status endpoint for more information.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelQuery IAM action in that cluster.

", "smithy.api#http": { "method": "DELETE", "uri": "/opencypher/status/{queryId}", @@ -1477,7 +1477,7 @@ "silent": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

If set to TRUE, causes the cancelation of the\n openCypher query to happen silently.

", + "smithy.api#documentation": "

If set to TRUE, causes the cancelation of the openCypher query to happen silently.

", "smithy.api#httpQuery": "silent" } } @@ -1601,7 +1601,7 @@ } }, "traits": { - "smithy.api#documentation": "

Raised when a request attempts to modify data that is concurrently being\n modified by another process.

", + "smithy.api#documentation": "

Raised when a request attempts to modify data that is concurrently being modified by another process.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} @@ -1683,7 +1683,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Neptune ML inference endpoint that lets you query\n one specific model that the model-training process constructed. See\n Managing\n inference endpoints using the endpoints command.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:CreateMLEndpoint\n IAM action in that cluster.

", + "smithy.api#documentation": "

Creates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed. See Managing inference endpoints using the endpoints command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CreateMLEndpoint IAM action in that cluster.

", "smithy.api#http": { "method": "POST", "uri": "/ml/endpoints", @@ -1697,55 +1697,55 @@ "id": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A unique identifier for the new inference endpoint. The default\n is an autogenerated timestamped name.

" + "smithy.api#documentation": "

A unique identifier for the new inference endpoint. The default is an autogenerated timestamped name.

" } }, "mlModelTrainingJobId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The job Id of the completed model-training job that has created the\n model that the inference endpoint will point to. You must supply either\n the mlModelTrainingJobId or the mlModelTransformJobId.

" + "smithy.api#documentation": "

The job Id of the completed model-training job that has created the model that the inference endpoint will point to. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

" } }, "mlModelTransformJobId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The job Id of the completed model-transform job. You must supply\n either the mlModelTrainingJobId or the mlModelTransformJobId.

" + "smithy.api#documentation": "

The job Id of the completed model-transform job. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

" } }, "update": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

If set to true, update indicates that this\n is an update request. The default is false. You must supply\n either the mlModelTrainingJobId or the mlModelTransformJobId.

" + "smithy.api#documentation": "

If set to true, update indicates that this is an update request. The default is false. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

" } }, "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role providing Neptune access to SageMaker and\n Amazon S3 resources. This must be listed in your DB cluster parameter\n group or an error will be thrown.

" + "smithy.api#documentation": "

The ARN of an IAM role providing Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will be thrown.

" } }, "modelName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Model type for training. By default the Neptune ML model is\n automatically based on the modelType used in data processing,\n but you can specify a different model type here. The default is\n rgcn for heterogeneous graphs and kge for\n knowledge graphs. The only valid value for heterogeneous graphs is\n rgcn. Valid values for knowledge graphs are: kge,\n transe, distmult, and rotate.

" + "smithy.api#documentation": "

Model type for training. By default the Neptune ML model is automatically based on the modelType used in data processing, but you can specify a different model type here. The default is rgcn for heterogeneous graphs and kge for knowledge graphs. The only valid value for heterogeneous graphs is rgcn. Valid values for knowledge graphs are: kge, transe, distmult, and rotate.

" } }, "instanceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The type of Neptune ML instance to use for online servicing.\n The default is ml.m5.xlarge. Choosing the ML instance\n for an inference endpoint depends on the task type, the graph size,\n and your budget.

" + "smithy.api#documentation": "

The type of Neptune ML instance to use for online servicing. The default is ml.m5.xlarge. Choosing the ML instance for an inference endpoint depends on the task type, the graph size, and your budget.

" } }, "instanceCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The minimum number of Amazon EC2 instances to deploy to an endpoint\n for prediction. The default is 1

" + "smithy.api#documentation": "

The minimum number of Amazon EC2 instances to deploy to an endpoint for prediction. The default is 1

" } }, "volumeEncryptionKMSKey": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses\n to encrypt data on the storage volume attached to the ML compute instances\n that run the training job. The default is None.

" + "smithy.api#documentation": "

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

" } } }, @@ -1785,25 +1785,25 @@ "sourceS3DirectoryPath": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The path to the Amazon S3 location where the Python module\n implementing your model is located. This must point to a valid\n existing Amazon S3 location that contains, at a minimum, a training\n script, a transform script, and a model-hpo-configuration.json\n file.

", + "smithy.api#documentation": "

The path to the Amazon S3 location where the Python module implementing your model is located. This must point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a model-hpo-configuration.json file.

", "smithy.api#required": {} } }, "trainingEntryPointScript": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the entry point in your module of a script that performs\n model training and takes hyperparameters as command-line arguments,\n including fixed hyperparameters. The default is training.py.

" + "smithy.api#documentation": "

The name of the entry point in your module of a script that performs model training and takes hyperparameters as command-line arguments, including fixed hyperparameters. The default is training.py.

" } }, "transformEntryPointScript": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the entry point in your module of a script that should\n be run after the best model from the hyperparameter search has been\n identified, to compute the model artifacts necessary for model deployment.\n It should be able to run with no command-line arguments.The default is\n transform.py.

" + "smithy.api#documentation": "

The name of the entry point in your module of a script that should be run after the best model from the hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It should be able to run with no command-line arguments.The default is transform.py.

" } } }, "traits": { - "smithy.api#documentation": "

Contains custom model training parameters. See Custom\n models in Neptune ML.

" + "smithy.api#documentation": "

Contains custom model training parameters. See Custom models in Neptune ML.

" } }, "com.amazonaws.neptunedata#CustomModelTransformParameters": { @@ -1812,19 +1812,19 @@ "sourceS3DirectoryPath": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The path to the Amazon S3 location where the Python module\n implementing your model is located. This must point to a valid\n existing Amazon S3 location that contains, at a minimum, a training\n script, a transform script, and a model-hpo-configuration.json\n file.

", + "smithy.api#documentation": "

The path to the Amazon S3 location where the Python module implementing your model is located. This must point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a model-hpo-configuration.json file.

", "smithy.api#required": {} } }, "transformEntryPointScript": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the entry point in your module of a script that should\n be run after the best model from the hyperparameter search has been\n identified, to compute the model artifacts necessary for model deployment.\n It should be able to run with no command-line arguments. The default\n is transform.py.

" + "smithy.api#documentation": "

The name of the entry point in your module of a script that should be run after the best model from the hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It should be able to run with no command-line arguments. The default is transform.py.

" } } }, "traits": { - "smithy.api#documentation": "

Contains custom model transform parameters. See Use\n a trained model to generate new model artifacts.

" + "smithy.api#documentation": "

Contains custom model transform parameters. See Use a trained model to generate new model artifacts.

" } }, "com.amazonaws.neptunedata#DeleteMLEndpoint": { @@ -1871,7 +1871,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the creation of a Neptune ML inference endpoint. See\n Managing\n inference endpoints using the endpoints command.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:DeleteMLEndpoint\n IAM action in that cluster.

", + "smithy.api#documentation": "

Cancels the creation of a Neptune ML inference endpoint. See Managing inference endpoints using the endpoints command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:DeleteMLEndpoint IAM action in that cluster.

", "smithy.api#http": { "method": "DELETE", "uri": "/ml/endpoints/{id}", @@ -1894,14 +1894,14 @@ "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role providing Neptune access to SageMaker and\n Amazon S3 resources. This must be listed in your DB cluster parameter\n group or an error will be thrown.

", + "smithy.api#documentation": "

The ARN of an IAM role providing Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will be thrown.

", "smithy.api#httpQuery": "neptuneIamRoleArn" } }, "clean": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

If this flag is set to TRUE, all Neptune ML S3 artifacts\n should be deleted when the job is stopped. The default is\n FALSE.

", + "smithy.api#documentation": "

If this flag is set to TRUE, all Neptune ML S3 artifacts should be deleted when the job is stopped. The default is FALSE.

", "smithy.api#httpQuery": "clean" } } @@ -1974,7 +1974,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes statistics for Gremlin and openCypher (property graph)\n data.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:DeleteStatistics\n IAM action in that cluster.

", + "smithy.api#documentation": "

Deletes statistics for Gremlin and openCypher (property graph) data.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:DeleteStatistics IAM action in that cluster.

", "smithy.api#http": { "method": "DELETE", "uri": "/propertygraph/statistics" @@ -1988,7 +1988,7 @@ "statusCode": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The HTTP response code: 200 if the delete was successful, or\n 204 if there were no statistics to delete.

", + "smithy.api#documentation": "

The HTTP response code: 200 if the delete was successful, or 204 if there were no statistics to delete.

", "smithy.api#httpResponseCode": {} } }, @@ -2059,7 +2059,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes SPARQL statistics

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:DeleteStatistics\n IAM action in that cluster.

", + "smithy.api#documentation": "

Deletes SPARQL statistics

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:DeleteStatistics IAM action in that cluster.

", "smithy.api#http": { "method": "DELETE", "uri": "/sparql/statistics" @@ -2073,7 +2073,7 @@ "statusCode": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The HTTP response code: 200 if the delete was successful, or\n 204 if there were no statistics to delete.

", + "smithy.api#documentation": "

The HTTP response code: 200 if the delete was successful, or 204 if there were no statistics to delete.

", "smithy.api#httpResponseCode": {} } }, @@ -2222,7 +2222,7 @@ } ], "traits": { - "smithy.api#documentation": "

The fast reset REST API lets you reset a Neptune graph quicky\n and easily, removing all of its data.

\n

Neptune fast reset is a two-step process. First you call ExecuteFastReset\n with action set to initiateDatabaseReset. This returns a\n UUID token which you then include when calling ExecuteFastReset again\n with action set to performDatabaseReset. See Empty an Amazon Neptune\n DB cluster using the fast reset API.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:ResetDatabase\n IAM action in that cluster.

", + "smithy.api#documentation": "

The fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data.

Neptune fast reset is a two-step process. First you call ExecuteFastReset with action set to initiateDatabaseReset. This returns a UUID token which you then include when calling ExecuteFastReset again with action set to performDatabaseReset. See Empty an Amazon Neptune DB cluster using the fast reset API.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ResetDatabase IAM action in that cluster.

", "smithy.api#http": { "method": "POST", "uri": "/system", @@ -2237,7 +2237,7 @@ "action": { "target": "com.amazonaws.neptunedata#Action", "traits": { - "smithy.api#documentation": "

The fast reset action. One of the following values:

\n
    \n
  • \n

    \n \n initiateDatabaseReset\n   –  \n This action generates a unique token needed to actually perform the \n fast reset.

    \n
    • \n
  • \n

    \n \n performDatabaseReset\n   –  \n This action uses the token generated by the initiateDatabaseReset action\n to actually perform the fast reset.

    \n

    \n

    • \n
", + "smithy.api#documentation": "

The fast reset action. One of the following values:

  • initiateDatabaseReset   –   This action generates a unique token needed to actually perform the fast reset.

  • performDatabaseReset   –   This action uses the token generated by the initiateDatabaseReset action to actually perform the fast reset.

", "smithy.api#required": {} } }, @@ -2258,14 +2258,14 @@ "status": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The status is only returned for the performDatabaseReset\n action, and indicates whether or not the fast reset rquest is accepted.

", + "smithy.api#documentation": "

The status is only returned for the performDatabaseReset action, and indicates whether or not the fast reset rquest is accepted.

", "smithy.api#required": {} } }, "payload": { "target": "com.amazonaws.neptunedata#FastResetToken", "traits": { - "smithy.api#documentation": "

The payload is only returned by the initiateDatabaseReset\n action, and contains the unique token to use with the performDatabaseReset\n action to make the reset occur.

" + "smithy.api#documentation": "

The payload is only returned by the initiateDatabaseReset action, and contains the unique token to use with the performDatabaseReset action to make the reset occur.

" } } }, @@ -2344,7 +2344,7 @@ } ], "traits": { - "smithy.api#documentation": "

Executes a Gremlin Explain query.

\n

Amazon Neptune has added a Gremlin feature named explain\n that provides is a self-service tool for understanding the execution\n approach being taken by the Neptune engine for the query. You invoke\n it by adding an explain parameter to an HTTP call that\n submits a Gremlin query.

\n

The explain feature provides information about the logical structure\n of query execution plans. You can use this information to identify\n potential evaluation and execution bottlenecks and to tune your query,\n as explained in Tuning\n Gremlin queries. You can also use query hints to improve\n query execution plans.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows one of the following IAM actions\n in that cluster, depending on the query:

\n \n

Note that the neptune-db:QueryLanguage:Gremlin\n IAM condition key can be used in the policy document to restrict the use of\n Gremlin queries (see Condition\n keys available in Neptune IAM data-access policy statements).

", + "smithy.api#documentation": "

Executes a Gremlin Explain query.

Amazon Neptune has added a Gremlin feature named explain that provides is a self-service tool for understanding the execution approach being taken by the Neptune engine for the query. You invoke it by adding an explain parameter to an HTTP call that submits a Gremlin query.

The explain feature provides information about the logical structure of query execution plans. You can use this information to identify potential evaluation and execution bottlenecks and to tune your query, as explained in Tuning Gremlin queries. You can also use query hints to improve query execution plans.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:

Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).

", "smithy.api#http": { "method": "POST", "uri": "/gremlin/explain", @@ -2374,7 +2374,7 @@ "output": { "target": "com.amazonaws.neptunedata#ReportAsText", "traits": { - "smithy.api#documentation": "

A text blob containing the Gremlin explain result, as described\n in Tuning\n Gremlin queries.

", + "smithy.api#documentation": "

A text blob containing the Gremlin explain result, as described in Tuning Gremlin queries.

", "smithy.api#httpPayload": {} } } @@ -2454,7 +2454,7 @@ } ], "traits": { - "smithy.api#documentation": "

Executes a Gremlin Profile query, which runs a specified traversal,\n collects various metrics about the run, and produces a profile report\n as output. See Gremlin profile\n API in Neptune for details.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:ReadDataViaQuery\n IAM action in that cluster.

\n

Note that the neptune-db:QueryLanguage:Gremlin\n IAM condition key can be used in the policy document to restrict the use of\n Gremlin queries (see Condition\n keys available in Neptune IAM data-access policy statements).

", + "smithy.api#documentation": "

Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output. See Gremlin profile API in Neptune for details.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ReadDataViaQuery IAM action in that cluster.

Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).

", "smithy.api#http": { "method": "POST", "uri": "/gremlin/profile", @@ -2476,28 +2476,28 @@ "results": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

If this flag is set to TRUE, the query results are\n gathered and displayed as part of the profile report.\n If FALSE, only the result count is displayed.

", + "smithy.api#documentation": "

If this flag is set to TRUE, the query results are gathered and displayed as part of the profile report. If FALSE, only the result count is displayed.

", "smithy.api#jsonName": "profile.results" } }, "chop": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

If non-zero, causes the results string to be truncated at that\n number of characters. If set to zero, the string contains all the results.

", + "smithy.api#documentation": "

If non-zero, causes the results string to be truncated at that number of characters. If set to zero, the string contains all the results.

", "smithy.api#jsonName": "profile.chop" } }, "serializer": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If non-null, the gathered results are returned in a serialized response\n message in the format specified by this parameter. See Gremlin profile\n API in Neptune for more information.

", + "smithy.api#documentation": "

If non-null, the gathered results are returned in a serialized response message in the format specified by this parameter. See Gremlin profile API in Neptune for more information.

", "smithy.api#jsonName": "profile.serializer" } }, "indexOps": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

If this flag is set to TRUE, the results include a\n detailed report of all index operations that took place during query\n execution and serialization.

", + "smithy.api#documentation": "

If this flag is set to TRUE, the results include a detailed report of all index operations that took place during query execution and serialization.

", "smithy.api#jsonName": "profile.indexOps" } } @@ -2512,7 +2512,7 @@ "output": { "target": "com.amazonaws.neptunedata#ReportAsText", "traits": { - "smithy.api#documentation": "

A text blob containing the Gremlin Profile result. See\n Gremlin\n profile API in Neptune for details.

", + "smithy.api#documentation": "

A text blob containing the Gremlin Profile result. See Gremlin profile API in Neptune for details.

", "smithy.api#httpPayload": {} } } @@ -2592,7 +2592,7 @@ } ], "traits": { - "smithy.api#documentation": "

This commands executes a Gremlin query. Amazon Neptune is compatible\n with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal\n language to query the graph, as described under The\n Graph in the Apache TinkerPop3 documentation.\n More details can also be found in Accessing a\n Neptune graph with Gremlin.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that enables one of the following IAM actions\n in that cluster, depending on the query:

\n \n

Note that the neptune-db:QueryLanguage:Gremlin\n IAM condition key can be used in the policy document to restrict the use of\n Gremlin queries (see Condition\n keys available in Neptune IAM data-access policy statements).

", + "smithy.api#documentation": "

This commands executes a Gremlin query. Amazon Neptune is compatible with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal language to query the graph, as described under The Graph in the Apache TinkerPop3 documentation. More details can also be found in Accessing a Neptune graph with Gremlin.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that enables one of the following IAM actions in that cluster, depending on the query:

Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).

", "smithy.api#http": { "method": "POST", "uri": "/gremlin", @@ -2606,7 +2606,7 @@ "gremlinQuery": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Using this API, you can run Gremlin queries in string format\n much as you can using the HTTP endpoint. The interface is\n compatible with whatever Gremlin version your DB cluster is using\n (see the Tinkerpop\n client section to determine which Gremlin releases your\n engine version supports).

", + "smithy.api#documentation": "

Using this API, you can run Gremlin queries in string format much as you can using the HTTP endpoint. The interface is compatible with whatever Gremlin version your DB cluster is using (see the Tinkerpop client section to determine which Gremlin releases your engine version supports).

", "smithy.api#jsonName": "gremlin", "smithy.api#required": {} } @@ -2614,7 +2614,7 @@ "serializer": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If non-null, the query results are returned in a serialized response\n message in the format specified by this parameter. See the GraphSON\n section in the TinkerPop documentation for a list of the formats that\n are currently supported.

", + "smithy.api#documentation": "

If non-null, the query results are returned in a serialized response message in the format specified by this parameter. See the GraphSON section in the TinkerPop documentation for a list of the formats that are currently supported.

", "smithy.api#httpHeader": "accept" } } @@ -2729,7 +2729,7 @@ } ], "traits": { - "smithy.api#documentation": "

Executes an openCypher explain request. See\n The\n openCypher explain feature for more information.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:ReadDataViaQuery\n IAM action in that cluster.

\n

Note that the neptune-db:QueryLanguage:OpenCypher\n IAM condition key can be used in the policy document to restrict the use of\n openCypher queries (see Condition\n keys available in Neptune IAM data-access policy statements).

", + "smithy.api#documentation": "

Executes an openCypher explain request. See The openCypher explain feature for more information.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ReadDataViaQuery IAM action in that cluster.

Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).

", "smithy.api#http": { "method": "POST", "uri": "/opencypher/explain", @@ -2758,7 +2758,7 @@ "explainMode": { "target": "com.amazonaws.neptunedata#OpenCypherExplainMode", "traits": { - "smithy.api#documentation": "

The openCypher explain mode. Can be one of:\n static, dynamic, or details.

", + "smithy.api#documentation": "

The openCypher explain mode. Can be one of: static, dynamic, or details.

", "smithy.api#jsonName": "explain", "smithy.api#required": {} } @@ -2858,7 +2858,7 @@ } ], "traits": { - "smithy.api#documentation": "

Executes an openCypher query. See Accessing\n the Neptune Graph with openCypher for more information.

\n

Neptune supports building graph applications using openCypher,\n which is currently one of the most popular query languages among\n developers working with graph databases. Developers, business analysts,\n and data scientists like openCypher's declarative, SQL-inspired syntax\n because it provides a familiar structure in which to querying property\n graphs.

\n

The openCypher language was originally developed by Neo4j, then\n open-sourced in 2015 and contributed to the openCypher project under an Apache\n 2 open-source license.

\n

Note that when invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows one of the following IAM actions\n in that cluster, depending on the query:

\n \n

Note also that the neptune-db:QueryLanguage:OpenCypher\n IAM condition key can be used in the policy document to restrict the use of\n openCypher queries (see Condition\n keys available in Neptune IAM data-access policy statements).

", + "smithy.api#documentation": "

Executes an openCypher query. See Accessing the Neptune Graph with openCypher for more information.

Neptune supports building graph applications using openCypher, which is currently one of the most popular query languages among developers working with graph databases. Developers, business analysts, and data scientists like openCypher's declarative, SQL-inspired syntax because it provides a familiar structure in which to querying property graphs.

The openCypher language was originally developed by Neo4j, then open-sourced in 2015 and contributed to the openCypher project under an Apache 2 open-source license.

Note that when invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:

Note also that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).

", "smithy.api#http": { "method": "POST", "uri": "/opencypher", @@ -2880,7 +2880,7 @@ "parameters": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The openCypher query parameters for query execution.\n See Examples\n of openCypher parameterized queries for more information.

" + "smithy.api#documentation": "

The openCypher query parameters for query execution. See Examples of openCypher parameterized queries for more information.

" } } }, @@ -2972,12 +2972,12 @@ "token": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A UUID generated by the database in the initiateDatabaseReset action,\n and then consumed by the performDatabaseReset to reset the database.

" + "smithy.api#documentation": "

A UUID generated by the database in the initiateDatabaseReset action, and then consumed by the performDatabaseReset to reset the database.

" } } }, "traits": { - "smithy.api#documentation": "

A structure containing the fast reset token used to initiate\n a fast reset.

" + "smithy.api#documentation": "

A structure containing the fast reset token used to initiate a fast reset.

" } }, "com.amazonaws.neptunedata#Format": { @@ -3056,7 +3056,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the status of the graph database on the host.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetEngineStatus\n IAM action in that cluster.

", + "smithy.api#documentation": "

Retrieves the status of the graph database on the host.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetEngineStatus IAM action in that cluster.

", "smithy.api#http": { "method": "GET", "uri": "/status", @@ -3071,7 +3071,7 @@ "status": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Set to healthy if the instance is not experiencing problems.\n If the instance is recovering from a crash or from being rebooted and there\n are active transactions running from the latest server shutdown, status is set\n to recovery.

" + "smithy.api#documentation": "

Set to healthy if the instance is not experiencing problems. If the instance is recovering from a crash or from being rebooted and there are active transactions running from the latest server shutdown, status is set to recovery.

" } }, "startTime": { @@ -3083,37 +3083,37 @@ "dbEngineVersion": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Set to the Neptune engine version running on your DB cluster.\n If this engine version has been manually patched since it was released,\n the version number is prefixed by Patch-.

" + "smithy.api#documentation": "

Set to the Neptune engine version running on your DB cluster. If this engine version has been manually patched since it was released, the version number is prefixed by Patch-.

" } }, "role": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Set to reader if the instance is a read-replica,\n or to writer if the instance is the primary instance.

" + "smithy.api#documentation": "

Set to reader if the instance is a read-replica, or to writer if the instance is the primary instance.

" } }, "dfeQueryEngine": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Set to enabled if the DFE engine is fully enabled,\n or to viaQueryHint (the default) if the DFE engine is\n only used with queries that have the useDFE query hint\n set to true.

" + "smithy.api#documentation": "

Set to enabled if the DFE engine is fully enabled, or to viaQueryHint (the default) if the DFE engine is only used with queries that have the useDFE query hint set to true.

" } }, "gremlin": { "target": "com.amazonaws.neptunedata#QueryLanguageVersion", "traits": { - "smithy.api#documentation": "

Contains information about the Gremlin query language available\n on your cluster. Specifically, it contains a version field that specifies\n the current TinkerPop version being used by the engine.

" + "smithy.api#documentation": "

Contains information about the Gremlin query language available on your cluster. Specifically, it contains a version field that specifies the current TinkerPop version being used by the engine.

" } }, "sparql": { "target": "com.amazonaws.neptunedata#QueryLanguageVersion", "traits": { - "smithy.api#documentation": "

Contains information about the SPARQL query language available\n on your cluster. Specifically, it contains a version field that\n specifies the current SPARQL version being used by the engine.

" + "smithy.api#documentation": "

Contains information about the SPARQL query language available on your cluster. Specifically, it contains a version field that specifies the current SPARQL version being used by the engine.

" } }, "opencypher": { "target": "com.amazonaws.neptunedata#QueryLanguageVersion", "traits": { - "smithy.api#documentation": "

Contains information about the openCypher query language available\n on your cluster. Specifically, it contains a version field that\n specifies the current operCypher version being used by the engine.

" + "smithy.api#documentation": "

Contains information about the openCypher query language available on your cluster. Specifically, it contains a version field that specifies the current operCypher version being used by the engine.

" } }, "labMode": { @@ -3125,13 +3125,13 @@ "rollingBackTrxCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

If there are transactions being rolled back, this field is set\n to the number of such transactions. If there are none, the field\n doesn't appear at all.

" + "smithy.api#documentation": "

If there are transactions being rolled back, this field is set to the number of such transactions. If there are none, the field doesn't appear at all.

" } }, "rollingBackTrxEarliestStartTime": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Set to the start time of the earliest transaction being rolled back.\n If no transactions are being rolled back, the field doesn't appear at all.

" + "smithy.api#documentation": "

Set to the start time of the earliest transaction being rolled back. If no transactions are being rolled back, the field doesn't appear at all.

" } }, "features": { @@ -3143,7 +3143,7 @@ "settings": { "target": "com.amazonaws.neptunedata#StringValuedMap", "traits": { - "smithy.api#documentation": "

Contains information about the current settings on your DB cluster.\n For example, contains the current cluster query timeout setting\n (clusterQueryTimeoutInMs).

" + "smithy.api#documentation": "

Contains information about the current settings on your DB cluster. For example, contains the current cluster query timeout setting (clusterQueryTimeoutInMs).

" } } }, @@ -3210,7 +3210,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the status of a specified Gremlin query.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetQueryStatus\n IAM action in that cluster.

\n

Note that the neptune-db:QueryLanguage:Gremlin\n IAM condition key can be used in the policy document to restrict the use of\n Gremlin queries (see Condition\n keys available in Neptune IAM data-access policy statements).

", + "smithy.api#documentation": "

Gets the status of a specified Gremlin query.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster.

Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).

", "smithy.api#http": { "method": "GET", "uri": "/gremlin/status/{queryId}", @@ -3311,7 +3311,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets status information about a specified load job.\n Neptune keeps track of the most recent 1,024 bulk load jobs,\n and stores the last 10,000 error details per job.

\n

See Neptune\n Loader Get-Status API for more information.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetLoaderJobStatus\n IAM action in that cluster..

", + "smithy.api#documentation": "

Gets status information about a specified load job. Neptune keeps track of the most recent 1,024 bulk load jobs, and stores the last 10,000 error details per job.

See Neptune Loader Get-Status API for more information.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetLoaderJobStatus IAM action in that cluster..

", "smithy.api#http": { "method": "GET", "uri": "/loader/{loadId}", @@ -3334,28 +3334,28 @@ "details": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Flag indicating whether or not to include details beyond the\n overall status (TRUE or FALSE; the default\n is FALSE).

", + "smithy.api#documentation": "

Flag indicating whether or not to include details beyond the overall status (TRUE or FALSE; the default is FALSE).

", "smithy.api#httpQuery": "details" } }, "errors": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Flag indicating whether or not to include a list of errors\n encountered (TRUE or FALSE; the default\n is FALSE).

\n

The list of errors is paged. The page and errorsPerPage\n parameters allow you to page through all the errors.

", + "smithy.api#documentation": "

Flag indicating whether or not to include a list of errors encountered (TRUE or FALSE; the default is FALSE).

The list of errors is paged. The page and errorsPerPage parameters allow you to page through all the errors.

", "smithy.api#httpQuery": "errors" } }, "page": { "target": "com.amazonaws.neptunedata#PositiveInteger", "traits": { - "smithy.api#documentation": "

The error page number (a positive integer; the default is 1).\n Only valid when the errors parameter is set to\n TRUE.

", + "smithy.api#documentation": "

The error page number (a positive integer; the default is 1). Only valid when the errors parameter is set to TRUE.

", "smithy.api#httpQuery": "page" } }, "errorsPerPage": { "target": "com.amazonaws.neptunedata#PositiveInteger", "traits": { - "smithy.api#documentation": "

The number of errors returned in each page (a positive integer; the\n default is 10). Only valid when the errors\n parameter set to TRUE.

", + "smithy.api#documentation": "

The number of errors returned in each page (a positive integer; the default is 10). Only valid when the errors parameter set to TRUE.

", "smithy.api#httpQuery": "errorsPerPage" } } @@ -3377,7 +3377,7 @@ "payload": { "target": "smithy.api#Document", "traits": { - "smithy.api#documentation": "

Status information about the load job, in a layout\n that could look like this:

", + "smithy.api#documentation": "

Status information about the load job, in a layout that could look like this:

", "smithy.api#required": {} } } @@ -3430,7 +3430,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a specified data processing job. See The\n dataprocessing command.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:neptune-db:GetMLDataProcessingJobStatus\n IAM action in that cluster.

", + "smithy.api#documentation": "

Retrieves information about a specified data processing job. See The dataprocessing command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:neptune-db:GetMLDataProcessingJobStatus IAM action in that cluster.

", "smithy.api#http": { "method": "GET", "uri": "/ml/dataprocessing/{id}", @@ -3453,7 +3453,7 @@ "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

", "smithy.api#httpQuery": "neptuneIamRoleArn" } } @@ -3532,7 +3532,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves details about an inference endpoint. See Managing\n inference endpoints using the endpoints command.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetMLEndpointStatus\n IAM action in that cluster.

", + "smithy.api#documentation": "

Retrieves details about an inference endpoint. See Managing inference endpoints using the endpoints command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetMLEndpointStatus IAM action in that cluster.

", "smithy.api#http": { "method": "GET", "uri": "/ml/endpoints/{id}", @@ -3555,7 +3555,7 @@ "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster parameter\n group or an error will occur.

", + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

", "smithy.api#httpQuery": "neptuneIamRoleArn" } } @@ -3640,7 +3640,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a Neptune ML model training job. See Model\n training using the modeltraining command.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetMLModelTrainingJobStatus\n IAM action in that cluster.

", + "smithy.api#documentation": "

Retrieves information about a Neptune ML model training job. See Model training using the modeltraining command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetMLModelTrainingJobStatus IAM action in that cluster.

", "smithy.api#http": { "method": "GET", "uri": "/ml/modeltraining/{id}", @@ -3663,7 +3663,7 @@ "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

", "smithy.api#httpQuery": "neptuneIamRoleArn" } } @@ -3760,7 +3760,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a specified model transform job. See Use\n a trained model to generate new model artifacts.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetMLModelTransformJobStatus\n IAM action in that cluster.

", + "smithy.api#documentation": "

Gets information about a specified model transform job. See Use a trained model to generate new model artifacts.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetMLModelTransformJobStatus IAM action in that cluster.

", "smithy.api#http": { "method": "GET", "uri": "/ml/modeltransform/{id}", @@ -3783,7 +3783,7 @@ "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

", "smithy.api#httpQuery": "neptuneIamRoleArn" } } @@ -3892,7 +3892,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the status of a specified openCypher query.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetQueryStatus\n IAM action in that cluster.

\n

Note that the neptune-db:QueryLanguage:OpenCypher\n IAM condition key can be used in the policy document to restrict the use of\n openCypher queries (see Condition\n keys available in Neptune IAM data-access policy statements).

", + "smithy.api#documentation": "

Retrieves the status of a specified openCypher query.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster.

Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).

", "smithy.api#http": { "method": "GET", "uri": "/opencypher/status/{queryId}", @@ -3907,7 +3907,7 @@ "queryId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The unique ID of the openCypher query for which to retrieve\n the query status.

", + "smithy.api#documentation": "

The unique ID of the openCypher query for which to retrieve the query status.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3993,7 +3993,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets property graph statistics (Gremlin and openCypher).

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetStatisticsStatus\n IAM action in that cluster.

", + "smithy.api#documentation": "

Gets property graph statistics (Gremlin and openCypher).

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetStatisticsStatus IAM action in that cluster.

", "smithy.api#http": { "method": "GET", "uri": "/propertygraph/statistics", @@ -4008,7 +4008,7 @@ "status": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded,\n the code is 200. See Common\n error codes for DFE statistics request for a list of common errors.

", + "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded, the code is 200. See Common error codes for DFE statistics request for a list of common errors.

", "smithy.api#required": {} } }, @@ -4071,7 +4071,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a stream for a property graph.

\n

With the Neptune Streams feature, you can generate a complete\n sequence of change-log entries that record every change made to your\n graph data as it happens. GetPropertygraphStream lets\n you collect these change-log entries for a property graph.

\n

The Neptune streams feature needs to be enabled on your Neptune\n DBcluster. To enable streams, set the neptune_streams\n DB cluster parameter to 1.

\n

See Capturing\n graph changes in real time using Neptune streams.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetStreamRecords\n IAM action in that cluster.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that enables one of the following IAM actions,\n depending on the query:

\n

Note that you can restrict property-graph queries using the\n following IAM context keys:

\n \n

See Condition\n keys available in Neptune IAM data-access policy statements).

", + "smithy.api#documentation": "

Gets a stream for a property graph.

With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens. GetPropertygraphStream lets you collect these change-log entries for a property graph.

The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1.

See Capturing graph changes in real time using Neptune streams.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetStreamRecords IAM action in that cluster.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that enables one of the following IAM actions, depending on the query:

Note that you can restrict property-graph queries using the following IAM context keys:

See Condition keys available in Neptune IAM data-access policy statements).

", "smithy.api#http": { "method": "GET", "uri": "/propertygraph/stream", @@ -4086,7 +4086,7 @@ "limit": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

Specifies the maximum number of records to return. There\n is also a size limit of 10 MB on the response that can't be modified\n and that takes precedence over the number of records specified in\n the limit parameter. The response does include a\n threshold-breaching record if the 10 MB limit was reached.

\n

The range for limit is 1 to 100,000, with a\n default of 10.

", + "smithy.api#documentation": "

Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the limit parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.

The range for limit is 1 to 100,000, with a default of 10.

", "smithy.api#httpQuery": "limit", "smithy.api#range": { "min": 1, @@ -4097,21 +4097,21 @@ "iteratorType": { "target": "com.amazonaws.neptunedata#IteratorType", "traits": { - "smithy.api#documentation": "

Can be one of:

\n
    \n
  • \n

    \n AT_SEQUENCE_NUMBER   –  \n Indicates that reading should start from the event sequence number\n specified jointly by the commitNum and\n opNum parameters.

    \n
    • \n
  • \n

    \n AFTER_SEQUENCE_NUMBER   –  \n Indicates that reading should start right after the event sequence number\n specified jointly by the commitNum and opNum\n parameters.

    \n
    • \n
  • \n

    \n TRIM_HORIZON   –  \n Indicates that reading should start at the last untrimmed record in the system,\n which is the oldest unexpired (not yet deleted) record in the change-log stream.

    \n
    • \n
  • \n

    \n LATEST   –  \n Indicates that reading should start at the most recent record in the system,\n which is the latest unexpired (not yet deleted) record in the change-log stream.

    \n
    • \n
", + "smithy.api#documentation": "

Can be one of:

  • AT_SEQUENCE_NUMBER   –   Indicates that reading should start from the event sequence number specified jointly by the commitNum and opNum parameters.

  • AFTER_SEQUENCE_NUMBER   –   Indicates that reading should start right after the event sequence number specified jointly by the commitNum and opNum parameters.

  • TRIM_HORIZON   –   Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.

  • LATEST   –   Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.

", "smithy.api#httpQuery": "iteratorType" } }, "commitNum": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The commit number of the starting record to read from the\n change-log stream. This parameter is required when iteratorType\n isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and\n ignored when iteratorType is TRIM_HORIZON or\n LATEST.

", + "smithy.api#documentation": "

The commit number of the starting record to read from the change-log stream. This parameter is required when iteratorType isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and ignored when iteratorType is TRIM_HORIZON or LATEST.

", "smithy.api#httpQuery": "commitNum" } }, "opNum": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The operation sequence number within the specified commit to\n start reading from in the change-log stream data. The default is 1.

", + "smithy.api#documentation": "

The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is 1.

", "smithy.api#httpQuery": "opNum" } }, @@ -4133,14 +4133,14 @@ "lastEventId": { "target": "com.amazonaws.neptunedata#StringValuedMap", "traits": { - "smithy.api#documentation": "

Sequence identifier of the last change in the stream response.

\n

An event ID is composed of two fields: a commitNum, which\n identifies a transaction that changed the graph, and an opNum,\n which identifies a specific operation within that transaction:

", + "smithy.api#documentation": "

Sequence identifier of the last change in the stream response.

An event ID is composed of two fields: a commitNum, which identifies a transaction that changed the graph, and an opNum, which identifies a specific operation within that transaction:

", "smithy.api#required": {} } }, "lastTrxTimestampInMillis": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The time at which the commit for the transaction was requested,\n in milliseconds from the Unix epoch.

", + "smithy.api#documentation": "

The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.

", "smithy.api#jsonName": "lastTrxTimestamp", "smithy.api#required": {} } @@ -4148,7 +4148,7 @@ "format": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Serialization format for the change records being returned.\n Currently, the only supported value is PG_JSON.

", + "smithy.api#documentation": "

Serialization format for the change records being returned. Currently, the only supported value is PG_JSON.

", "smithy.api#required": {} } }, @@ -4221,7 +4221,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a graph summary for a property graph.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetGraphSummary\n IAM action in that cluster.

", + "smithy.api#documentation": "

Gets a graph summary for a property graph.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetGraphSummary IAM action in that cluster.

", "smithy.api#http": { "method": "GET", "uri": "/propertygraph/statistics/summary", @@ -4237,7 +4237,7 @@ "target": "com.amazonaws.neptunedata#GraphSummaryType", "traits": { "smithy.api#default": "basic", - "smithy.api#documentation": "

Mode can take one of two values: BASIC (the default),\n and DETAILED.

", + "smithy.api#documentation": "

Mode can take one of two values: BASIC (the default), and DETAILED.

", "smithy.api#httpQuery": "mode" } } @@ -4252,7 +4252,7 @@ "statusCode": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded,\n the code is 200.

", + "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded, the code is 200.

", "smithy.api#httpResponseCode": {} } }, @@ -4317,7 +4317,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a graph summary for an RDF graph.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetGraphSummary\n IAM action in that cluster.

", + "smithy.api#documentation": "

Gets a graph summary for an RDF graph.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetGraphSummary IAM action in that cluster.

", "smithy.api#http": { "method": "GET", "uri": "/rdf/statistics/summary", @@ -4333,7 +4333,7 @@ "target": "com.amazonaws.neptunedata#GraphSummaryType", "traits": { "smithy.api#default": "basic", - "smithy.api#documentation": "

Mode can take one of two values: BASIC (the default),\n and DETAILED.

", + "smithy.api#documentation": "

Mode can take one of two values: BASIC (the default), and DETAILED.

", "smithy.api#httpQuery": "mode" } } @@ -4348,7 +4348,7 @@ "statusCode": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded,\n the code is 200.

", + "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded, the code is 200.

", "smithy.api#httpResponseCode": {} } }, @@ -4428,7 +4428,7 @@ "status": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded,\n the code is 200. See Common\n error codes for DFE statistics request for a list of common errors.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetStatisticsStatus\n IAM action in that cluster.

", + "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded, the code is 200. See Common error codes for DFE statistics request for a list of common errors.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetStatisticsStatus IAM action in that cluster.

", "smithy.api#required": {} } }, @@ -4491,7 +4491,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a stream for an RDF graph.

\n

With the Neptune Streams feature, you can generate a complete\n sequence of change-log entries that record every change made to your\n graph data as it happens. GetSparqlStream lets\n you collect these change-log entries for an RDF graph.

\n

The Neptune streams feature needs to be enabled on your Neptune\n DBcluster. To enable streams, set the neptune_streams\n DB cluster parameter to 1.

\n

See Capturing\n graph changes in real time using Neptune streams.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetStreamRecords\n IAM action in that cluster.

\n

Note that the neptune-db:QueryLanguage:Sparql\n IAM condition key can be used in the policy document to restrict the use of\n SPARQL queries (see Condition\n keys available in Neptune IAM data-access policy statements).

", + "smithy.api#documentation": "

Gets a stream for an RDF graph.

With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens. GetSparqlStream lets you collect these change-log entries for an RDF graph.

The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1.

See Capturing graph changes in real time using Neptune streams.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetStreamRecords IAM action in that cluster.

Note that the neptune-db:QueryLanguage:Sparql IAM condition key can be used in the policy document to restrict the use of SPARQL queries (see Condition keys available in Neptune IAM data-access policy statements).

", "smithy.api#http": { "method": "GET", "uri": "/sparql/stream", @@ -4506,7 +4506,7 @@ "limit": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

Specifies the maximum number of records to return. There\n is also a size limit of 10 MB on the response that can't be modified\n and that takes precedence over the number of records specified in\n the limit parameter. The response does include a\n threshold-breaching record if the 10 MB limit was reached.

\n

The range for limit is 1 to 100,000, with a\n default of 10.

", + "smithy.api#documentation": "

Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the limit parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.

The range for limit is 1 to 100,000, with a default of 10.

", "smithy.api#httpQuery": "limit", "smithy.api#range": { "min": 1, @@ -4517,21 +4517,21 @@ "iteratorType": { "target": "com.amazonaws.neptunedata#IteratorType", "traits": { - "smithy.api#documentation": "

Can be one of:

\n
    \n
  • \n

    \n AT_SEQUENCE_NUMBER   –  \n Indicates that reading should start from the event sequence number\n specified jointly by the commitNum and\n opNum parameters.

    \n
    • \n
  • \n

    \n AFTER_SEQUENCE_NUMBER   –  \n Indicates that reading should start right after the event sequence number\n specified jointly by the commitNum and opNum\n parameters.

    \n
    • \n
  • \n

    \n TRIM_HORIZON   –  \n Indicates that reading should start at the last untrimmed record in the system,\n which is the oldest unexpired (not yet deleted) record in the change-log stream.

    \n
    • \n
  • \n

    \n LATEST   –  \n Indicates that reading should start at the most recent record in the system,\n which is the latest unexpired (not yet deleted) record in the change-log stream.

    \n
    • \n
", + "smithy.api#documentation": "

Can be one of:

  • AT_SEQUENCE_NUMBER   –   Indicates that reading should start from the event sequence number specified jointly by the commitNum and opNum parameters.

  • AFTER_SEQUENCE_NUMBER   –   Indicates that reading should start right after the event sequence number specified jointly by the commitNum and opNum parameters.

  • TRIM_HORIZON   –   Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.

  • LATEST   –   Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.

", "smithy.api#httpQuery": "iteratorType" } }, "commitNum": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The commit number of the starting record to read from the\n change-log stream. This parameter is required when iteratorType\n isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and\n ignored when iteratorType is TRIM_HORIZON or\n LATEST.

", + "smithy.api#documentation": "

The commit number of the starting record to read from the change-log stream. This parameter is required when iteratorType isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and ignored when iteratorType is TRIM_HORIZON or LATEST.

", "smithy.api#httpQuery": "commitNum" } }, "opNum": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The operation sequence number within the specified commit to\n start reading from in the change-log stream data. The default is 1.

", + "smithy.api#documentation": "

The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is 1.

", "smithy.api#httpQuery": "opNum" } }, @@ -4553,14 +4553,14 @@ "lastEventId": { "target": "com.amazonaws.neptunedata#StringValuedMap", "traits": { - "smithy.api#documentation": "

Sequence identifier of the last change in the stream response.

\n

An event ID is composed of two fields: a commitNum, which\n identifies a transaction that changed the graph, and an opNum,\n which identifies a specific operation within that transaction:

", + "smithy.api#documentation": "

Sequence identifier of the last change in the stream response.

An event ID is composed of two fields: a commitNum, which identifies a transaction that changed the graph, and an opNum, which identifies a specific operation within that transaction:

", "smithy.api#required": {} } }, "lastTrxTimestampInMillis": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The time at which the commit for the transaction was requested,\n in milliseconds from the Unix epoch.

", + "smithy.api#documentation": "

The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.

", "smithy.api#jsonName": "lastTrxTimestamp", "smithy.api#required": {} } @@ -4568,7 +4568,7 @@ "format": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Serialization format for the change records being returned.\n Currently, the only supported value is NQUADS.

", + "smithy.api#documentation": "

Serialization format for the change records being returned. Currently, the only supported value is NQUADS.

", "smithy.api#required": {} } }, @@ -4637,7 +4637,7 @@ } }, "traits": { - "smithy.api#documentation": "

Captures the status of a Gremlin query (see the Gremlin query\n status API page).

" + "smithy.api#documentation": "

Captures the status of a Gremlin query (see the Gremlin query status API page).

" } }, "com.amazonaws.neptunedata#GremlinQueryStatusAttributes": { @@ -4909,7 +4909,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists active Gremlin queries. See Gremlin query\n status API for details about the output.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetQueryStatus\n IAM action in that cluster.

\n

Note that the neptune-db:QueryLanguage:Gremlin\n IAM condition key can be used in the policy document to restrict the use of\n Gremlin queries (see Condition\n keys available in Neptune IAM data-access policy statements).

", + "smithy.api#documentation": "

Lists active Gremlin queries. See Gremlin query status API for details about the output.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster.

Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).

", "smithy.api#http": { "method": "GET", "uri": "/gremlin/status", @@ -4924,7 +4924,7 @@ "includeWaiting": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

If set to TRUE, the list returned includes waiting\n queries. The default is FALSE;

", + "smithy.api#documentation": "

If set to TRUE, the list returned includes waiting queries. The default is FALSE;

", "smithy.api#httpQuery": "includeWaiting" } } @@ -4939,7 +4939,7 @@ "acceptedQueryCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of queries that have been accepted but not yet\n completed, including queries in the queue.

" + "smithy.api#documentation": "

The number of queries that have been accepted but not yet completed, including queries in the queue.

" } }, "runningQueryCount": { @@ -5006,7 +5006,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of the loadIds for all active\n loader jobs.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:ListLoaderJobs\n IAM action in that cluster..

", + "smithy.api#documentation": "

Retrieves a list of the loadIds for all active loader jobs.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListLoaderJobs IAM action in that cluster..

", "smithy.api#http": { "method": "GET", "uri": "/loader", @@ -5021,7 +5021,7 @@ "limit": { "target": "com.amazonaws.neptunedata#PositiveInteger", "traits": { - "smithy.api#documentation": "

The number of load IDs to list. Must be a positive integer\n greater than zero and not more than 100 (which is the default).

", + "smithy.api#documentation": "

The number of load IDs to list. Must be a positive integer greater than zero and not more than 100 (which is the default).

", "smithy.api#httpQuery": "limit", "smithy.api#range": { "min": 1, @@ -5032,7 +5032,7 @@ "includeQueuedLoads": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

An optional parameter that can be used to exclude the load\n IDs of queued load requests when requesting a list of load IDs by\n setting the parameter to FALSE. The default value\n is TRUE.

", + "smithy.api#documentation": "

An optional parameter that can be used to exclude the load IDs of queued load requests when requesting a list of load IDs by setting the parameter to FALSE. The default value is TRUE.

", "smithy.api#httpQuery": "includeQueuedLoads" } } @@ -5107,7 +5107,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of Neptune ML data processing jobs. See Listing\n active data-processing jobs using the Neptune ML dataprocessing command.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:ListMLDataProcessingJobs\n IAM action in that cluster.

", + "smithy.api#documentation": "

Returns a list of Neptune ML data processing jobs. See Listing active data-processing jobs using the Neptune ML dataprocessing command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListMLDataProcessingJobs IAM action in that cluster.

", "smithy.api#http": { "method": "GET", "uri": "/ml/dataprocessing", @@ -5133,7 +5133,7 @@ "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

", "smithy.api#httpQuery": "neptuneIamRoleArn" } } @@ -5200,7 +5200,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists existing inference endpoints. See Managing\n inference endpoints using the endpoints command.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:ListMLEndpoints\n IAM action in that cluster.

", + "smithy.api#documentation": "

Lists existing inference endpoints. See Managing inference endpoints using the endpoints command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListMLEndpoints IAM action in that cluster.

", "smithy.api#http": { "method": "GET", "uri": "/ml/endpoints", @@ -5215,7 +5215,7 @@ "maxItems": { "target": "com.amazonaws.neptunedata#PositiveInteger", "traits": { - "smithy.api#documentation": "

The maximum number of items to return (from 1 to 1024; the default\n is 10.

", + "smithy.api#documentation": "

The maximum number of items to return (from 1 to 1024; the default is 10.

", "smithy.api#httpQuery": "maxItems", "smithy.api#range": { "min": 1, @@ -5226,7 +5226,7 @@ "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

", "smithy.api#httpQuery": "neptuneIamRoleArn" } } @@ -5293,7 +5293,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists Neptune ML model-training jobs. See Model\n training using the modeltraining command.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:neptune-db:ListMLModelTrainingJobs\n IAM action in that cluster.

", + "smithy.api#documentation": "

Lists Neptune ML model-training jobs. See Model training using the modeltraining command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:neptune-db:ListMLModelTrainingJobs IAM action in that cluster.

", "smithy.api#http": { "method": "GET", "uri": "/ml/modeltraining", @@ -5308,7 +5308,7 @@ "maxItems": { "target": "com.amazonaws.neptunedata#PositiveInteger", "traits": { - "smithy.api#documentation": "

The maximum number of items to return (from 1 to 1024; the default\n is 10).

", + "smithy.api#documentation": "

The maximum number of items to return (from 1 to 1024; the default is 10).

", "smithy.api#httpQuery": "maxItems", "smithy.api#range": { "min": 1, @@ -5319,7 +5319,7 @@ "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

", "smithy.api#httpQuery": "neptuneIamRoleArn" } } @@ -5386,7 +5386,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of model transform job IDs. See Use\n a trained model to generate new model artifacts.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:ListMLModelTransformJobs\n IAM action in that cluster.

", + "smithy.api#documentation": "

Returns a list of model transform job IDs. See Use a trained model to generate new model artifacts.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListMLModelTransformJobs IAM action in that cluster.

", "smithy.api#http": { "method": "GET", "uri": "/ml/modeltransform", @@ -5401,7 +5401,7 @@ "maxItems": { "target": "com.amazonaws.neptunedata#PositiveInteger", "traits": { - "smithy.api#documentation": "

The maximum number of items to return (from 1 to 1024; the\n default is 10).

", + "smithy.api#documentation": "

The maximum number of items to return (from 1 to 1024; the default is 10).

", "smithy.api#httpQuery": "maxItems", "smithy.api#range": { "min": 1, @@ -5412,7 +5412,7 @@ "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

", "smithy.api#httpQuery": "neptuneIamRoleArn" } } @@ -5497,7 +5497,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists active openCypher queries. See Neptune\n openCypher status endpoint for more information.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:GetQueryStatus\n IAM action in that cluster.

\n

Note that the neptune-db:QueryLanguage:OpenCypher\n IAM condition key can be used in the policy document to restrict the use of\n openCypher queries (see Condition\n keys available in Neptune IAM data-access policy statements).

", + "smithy.api#documentation": "

Lists active openCypher queries. See Neptune openCypher status endpoint for more information.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster.

Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).

", "smithy.api#http": { "method": "GET", "uri": "/opencypher/status", @@ -5512,7 +5512,7 @@ "includeWaiting": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

When set to TRUE and other parameters are not\n present, causes status information to be returned for waiting\n queries as well as for running queries.

", + "smithy.api#documentation": "

When set to TRUE and other parameters are not present, causes status information to be returned for waiting queries as well as for running queries.

", "smithy.api#httpQuery": "includeWaiting" } } @@ -5527,7 +5527,7 @@ "acceptedQueryCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of queries that have been accepted but not yet completed,\n including queries in the queue.

" + "smithy.api#documentation": "

The number of queries that have been accepted but not yet completed, including queries in the queue.

" } }, "runningQueryCount": { @@ -5664,7 +5664,7 @@ } }, "traits": { - "smithy.api#documentation": "

Raised when a query is submitted that is syntactically incorrect or does not\n pass additional validation.

", + "smithy.api#documentation": "

Raised when a query is submitted that is syntactically incorrect or does not pass additional validation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -5719,7 +5719,7 @@ } ], "traits": { - "smithy.api#documentation": "

Manages the generation and use of property graph statistics.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:ManageStatistics\n IAM action in that cluster.

", + "smithy.api#documentation": "

Manages the generation and use of property graph statistics.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ManageStatistics IAM action in that cluster.

", "smithy.api#http": { "method": "POST", "uri": "/propertygraph/statistics", @@ -5734,7 +5734,7 @@ "mode": { "target": "com.amazonaws.neptunedata#StatisticsAutoGenerationMode", "traits": { - "smithy.api#documentation": "

The statistics generation mode. One of: DISABLE_AUTOCOMPUTE,\n ENABLE_AUTOCOMPUTE, or REFRESH, the last of\n which manually triggers DFE statistics generation.

" + "smithy.api#documentation": "

The statistics generation mode. One of: DISABLE_AUTOCOMPUTE, ENABLE_AUTOCOMPUTE, or REFRESH, the last of which manually triggers DFE statistics generation.

" } } }, @@ -5748,7 +5748,7 @@ "status": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded,\n the code is 200.

", + "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded, the code is 200.

", "smithy.api#required": {} } }, @@ -5813,7 +5813,7 @@ } ], "traits": { - "smithy.api#documentation": "

Manages the generation and use of RDF graph statistics.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:ManageStatistics\n IAM action in that cluster.

", + "smithy.api#documentation": "

Manages the generation and use of RDF graph statistics.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ManageStatistics IAM action in that cluster.

", "smithy.api#http": { "method": "POST", "uri": "/sparql/statistics", @@ -5828,7 +5828,7 @@ "mode": { "target": "com.amazonaws.neptunedata#StatisticsAutoGenerationMode", "traits": { - "smithy.api#documentation": "

The statistics generation mode. One of: DISABLE_AUTOCOMPUTE,\n ENABLE_AUTOCOMPUTE, or REFRESH, the last of\n which manually triggers DFE statistics generation.

" + "smithy.api#documentation": "

The statistics generation mode. One of: DISABLE_AUTOCOMPUTE, ENABLE_AUTOCOMPUTE, or REFRESH, the last of which manually triggers DFE statistics generation.

" } } }, @@ -5842,7 +5842,7 @@ "status": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded,\n the code is 200.

", + "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded, the code is 200.

", "smithy.api#required": {} } }, @@ -5883,7 +5883,7 @@ } }, "traits": { - "smithy.api#documentation": "

Raised when a request fails because of insufficient memory resources. The\n request can be retried.

", + "smithy.api#documentation": "

Raised when a request fails because of insufficient memory resources. The request can be retried.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} @@ -5915,7 +5915,7 @@ } }, "traits": { - "smithy.api#documentation": "

Raised when the HTTP method used by a request is not supported by the endpoint\n being used.

", + "smithy.api#documentation": "

Raised when the HTTP method used by a request is not supported by the endpoint being used.

", "smithy.api#error": "client", "smithy.api#httpError": 405 } @@ -6247,7 +6247,7 @@ "type": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The type of this Gremlin or openCypher element. Must be one of:

\n
    \n
  • \n

    \n \n v1\n   -  \n Vertex label for Gremlin, or node label for openCypher.

    \n
    • \n
  • \n

    \n \n vp\n   -  \n Vertex properties for Gremlin, or node properties for openCypher.

    \n
    • \n
  • \n

    \n \n e\n   -  \n Edge and edge label for Gremlin, or relationship and relationship type\n for openCypher.

    \n
    • \n
  • \n

    \n \n ep\n   -  \n Edge properties for Gremlin, or relationship properties for openCypher.

    \n
    • \n
", + "smithy.api#documentation": "

The type of this Gremlin or openCypher element. Must be one of:

  • v1   -   Vertex label for Gremlin, or node label for openCypher.

  • vp   -   Vertex properties for Gremlin, or node properties for openCypher.

  • e   -   Edge and edge label for Gremlin, or relationship and relationship type for openCypher.

  • ep   -   Edge properties for Gremlin, or relationship properties for openCypher.

", "smithy.api#required": {} } }, @@ -6261,20 +6261,20 @@ "value": { "target": "smithy.api#Document", "traits": { - "smithy.api#documentation": "

This is a JSON object that contains a value field for the value itself,\n and a datatype field for the JSON data type of that value:

", + "smithy.api#documentation": "

This is a JSON object that contains a value field for the value itself, and a datatype field for the JSON data type of that value:

", "smithy.api#required": {} } }, "from": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If this is an edge (type = e), the ID of the\n corresponding from vertex or source node.

" + "smithy.api#documentation": "

If this is an edge (type = e), the ID of the corresponding from vertex or source node.

" } }, "to": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If this is an edge (type = e), the ID of the\n corresponding to vertex or target node.

" + "smithy.api#documentation": "

If this is an edge (type = e), the ID of the corresponding to vertex or target node.

" } } }, @@ -6288,7 +6288,7 @@ "commitTimestampInMillis": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The time at which the commit for the transaction was requested,\n in milliseconds from the Unix epoch.

", + "smithy.api#documentation": "

The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.

", "smithy.api#jsonName": "commitTimestamp", "smithy.api#required": {} } @@ -6317,7 +6317,7 @@ "isLastOp": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Only present if this operation is the last one in its transaction.\n If present, it is set to true. It is useful for ensuring that an\n entire transaction is consumed.

" + "smithy.api#documentation": "

Only present if this operation is the last one in its transaction. If present, it is set to true. It is useful for ensuring that an entire transaction is consumed.

" } } }, @@ -6373,7 +6373,7 @@ "numNodeProperties": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

A list of the distinct node properties in the graph, along\n with the count of nodes where each property is used.

" + "smithy.api#documentation": "

A list of the distinct node properties in the graph, along with the count of nodes where each property is used.

" } }, "numEdgeProperties": { @@ -6391,7 +6391,7 @@ "edgeProperties": { "target": "com.amazonaws.neptunedata#LongValuedMapList", "traits": { - "smithy.api#documentation": "

A list of the distinct edge properties in the graph, along\n with the count of edges where each property is used.

" + "smithy.api#documentation": "

A list of the distinct edge properties in the graph, along with the count of edges where each property is used.

" } }, "totalNodePropertyValues": { @@ -6409,18 +6409,18 @@ "nodeStructures": { "target": "com.amazonaws.neptunedata#NodeStructures", "traits": { - "smithy.api#documentation": "

This field is only present when the requested mode is\n DETAILED. It contains a list of node structures.

" + "smithy.api#documentation": "

This field is only present when the requested mode is DETAILED. It contains a list of node structures.

" } }, "edgeStructures": { "target": "com.amazonaws.neptunedata#EdgeStructures", "traits": { - "smithy.api#documentation": "

This field is only present when the requested mode is\n DETAILED. It contains a list of edge structures.

" + "smithy.api#documentation": "

This field is only present when the requested mode is DETAILED. It contains a list of edge structures.

" } } }, "traits": { - "smithy.api#documentation": "

The graph summary API returns a read-only list of node and edge\n labels and property keys, along with counts of nodes, edges, and\n properties. See Graph\n summary response for a property graph (PG).

" + "smithy.api#documentation": "

The graph summary API returns a read-only list of node and edge labels and property keys, along with counts of nodes, edges, and properties. See Graph summary response for a property graph (PG).

" } }, "com.amazonaws.neptunedata#PropertygraphSummaryValueMap": { @@ -6468,7 +6468,7 @@ "cancelled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Set to TRUE if the query was cancelled, or FALSE\n otherwise.

" + "smithy.api#documentation": "

Set to TRUE if the query was cancelled, or FALSE otherwise.

" } }, "subqueries": { @@ -6479,7 +6479,7 @@ } }, "traits": { - "smithy.api#documentation": "

Structure to capture query statistics such as how many queries\n are running, accepted or waiting and their details.

" + "smithy.api#documentation": "

Structure to capture query statistics such as how many queries are running, accepted or waiting and their details.

" } }, "com.amazonaws.neptunedata#QueryLanguageVersion": { @@ -6523,7 +6523,7 @@ } }, "traits": { - "smithy.api#documentation": "

Raised when the number of active queries exceeds what the server can process.\n The query in question can be retried when the system is less busy.

", + "smithy.api#documentation": "

Raised when the number of active queries exceeds what the server can process. The query in question can be retried when the system is less busy.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} @@ -6633,12 +6633,12 @@ "subjectStructures": { "target": "com.amazonaws.neptunedata#SubjectStructures", "traits": { - "smithy.api#documentation": "

This field is only present when the request mode is\n DETAILED. It contains a list of subject structures.

" + "smithy.api#documentation": "

This field is only present when the request mode is DETAILED. It contains a list of subject structures.

" } } }, "traits": { - "smithy.api#documentation": "

The RDF graph summary API returns a read-only list of classes and\n predicate keys, along with counts of quads, subjects, and predicates.

" + "smithy.api#documentation": "

The RDF graph summary API returns a read-only list of classes and predicate keys, along with counts of quads, subjects, and predicates.

" } }, "com.amazonaws.neptunedata#RDFGraphSummaryValueMap": { @@ -6653,14 +6653,14 @@ "lastStatisticsComputationTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp, in ISO 8601 format, of the time at which Neptune\n last computed statistics.

", + "smithy.api#documentation": "

The timestamp, in ISO 8601 format, of the time at which Neptune last computed statistics.

", "smithy.api#timestampFormat": "date-time" } }, "graphSummary": { "target": "com.amazonaws.neptunedata#RDFGraphSummary", "traits": { - "smithy.api#documentation": "

The graph summary of an RDF graph. See Graph\n summary response for an RDF graph.

" + "smithy.api#documentation": "

The graph summary of an RDF graph. See Graph summary response for an RDF graph.

" } } }, @@ -6859,6 +6859,84 @@ "traits": { "smithy.api#enumValue": "us-gov-east-1" } + }, + "CA_WEST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-west-1" + } + }, + "EU_SOUTH_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-2" + } + }, + "IL_CENTRAL_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "il-central-1" + } + }, + "ME_CENTRAL_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-central-1" + } + }, + "AP_NORTHEAST_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-3" + } + }, + "AP_SOUTHEAST_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-3" + } + }, + "AP_SOUTHEAST_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-4" + } + }, + "AP_SOUTHEAST_5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-5" + } + }, + "AP_SOUTHEAST_7": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-7" + } + }, + "MX_CENTRAL_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mx-central-1" + } + }, + "AP_EAST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-2" + } + }, + "AP_SOUTH_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-2" + } + }, + "EU_CENTRAL_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-2" + } } } }, @@ -6931,13 +7009,13 @@ "stmt": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Holds an N-QUADS\n statement expressing the changed quad.

", + "smithy.api#documentation": "

Holds an N-QUADS statement expressing the changed quad.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Neptune logs are converted to SPARQL quads in the graph using the\n Resource Description Framework (RDF) N-QUADS language defined\n in the W3C RDF 1.1 N-Quads specification

" + "smithy.api#documentation": "

Neptune logs are converted to SPARQL quads in the graph using the Resource Description Framework (RDF) N-QUADS language defined in the W3C RDF 1.1 N-Quads specification

" } }, "com.amazonaws.neptunedata#SparqlRecord": { @@ -6946,7 +7024,7 @@ "commitTimestampInMillis": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The time at which the commit for the transaction was requested,\n in milliseconds from the Unix epoch.

", + "smithy.api#documentation": "

The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.

", "smithy.api#jsonName": "commitTimestamp", "smithy.api#required": {} } @@ -6961,7 +7039,7 @@ "data": { "target": "com.amazonaws.neptunedata#SparqlData", "traits": { - "smithy.api#documentation": "

The serialized SPARQL change record. The serialization formats\n of each record are described in more detail in Serialization\n Formats in Neptune Streams.

", + "smithy.api#documentation": "

The serialized SPARQL change record. The serialization formats of each record are described in more detail in Serialization Formats in Neptune Streams.

", "smithy.api#required": {} } }, @@ -6975,12 +7053,12 @@ "isLastOp": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Only present if this operation is the last one in its transaction.\n If present, it is set to true. It is useful for ensuring that an\n entire transaction is consumed.

" + "smithy.api#documentation": "

Only present if this operation is the last one in its transaction. If present, it is set to true. It is useful for ensuring that an entire transaction is consumed.

" } } }, "traits": { - "smithy.api#documentation": "

A serialized SPARQL stream record capturing a change-log entry\n for the RDF graph.

" + "smithy.api#documentation": "

A serialized SPARQL stream record capturing a change-log entry for the RDF graph.

" } }, "com.amazonaws.neptunedata#SparqlRecordsList": { @@ -7042,7 +7120,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a Neptune bulk loader job to load data from an Amazon S3\n bucket into a Neptune DB instance. See Using the Amazon Neptune\n Bulk Loader to Ingest Data.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:StartLoaderJob\n IAM action in that cluster.

", + "smithy.api#documentation": "

Starts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance. See Using the Amazon Neptune Bulk Loader to Ingest Data.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartLoaderJob IAM action in that cluster.

", "smithy.api#http": { "method": "POST", "uri": "/loader", @@ -7057,14 +7135,14 @@ "source": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The source parameter accepts an S3 URI that identifies a single\n file, multiple files, a folder, or multiple folders. Neptune loads every data file\n in any folder that is specified.

\n

The URI can be in any of the following formats.

\n
    \n
  • \n

    \n s3://(bucket_name)/(object-key-name)\n

    \n
    • \n
  • \n

    \n https://s3.amazonaws.com/(bucket_name)/(object-key-name)\n

    \n
    • \n
  • \n

    \n https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)\n

    \n
    • \n
\n

The object-key-name element of the URI is equivalent to the prefix\n parameter in an S3 ListObjects\n API call. It identifies all the objects in the specified S3 bucket whose names begin with\n that prefix. That can be a single file or folder, or multiple files and/or folders.

\n

The specified folder or folders can contain multiple vertex files and multiple edge files.

", + "smithy.api#documentation": "

The source parameter accepts an S3 URI that identifies a single file, multiple files, a folder, or multiple folders. Neptune loads every data file in any folder that is specified.

The URI can be in any of the following formats.

  • s3://(bucket_name)/(object-key-name)

  • https://s3.amazonaws.com/(bucket_name)/(object-key-name)

  • https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)

The object-key-name element of the URI is equivalent to the prefix parameter in an S3 ListObjects API call. It identifies all the objects in the specified S3 bucket whose names begin with that prefix. That can be a single file or folder, or multiple files and/or folders.

The specified folder or folders can contain multiple vertex files and multiple edge files.

", "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.neptunedata#Format", "traits": { - "smithy.api#documentation": "

The format of the data. For more information about data formats for the Neptune\n Loader command, see Load Data Formats.

\n

\n Allowed values\n

\n ", + "smithy.api#documentation": "

The format of the data. For more information about data formats for the Neptune Loader command, see Load Data Formats.

Allowed values

", "smithy.api#required": {} } }, @@ -7079,56 +7157,56 @@ "iamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role to be assumed by\n the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided\n here should be attached to the DB cluster (see Adding\n the IAM Role to an Amazon Neptune Cluster.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided here should be attached to the DB cluster (see Adding the IAM Role to an Amazon Neptune Cluster.

", "smithy.api#required": {} } }, "mode": { "target": "com.amazonaws.neptunedata#Mode", "traits": { - "smithy.api#documentation": "

The load job mode.

\n

\n Allowed values: RESUME, NEW,\n AUTO.

\n

\n Default value: AUTO.

\n

\n \n

\n
    \n
  • \n

    \n RESUME   –   In RESUME mode,\n the loader looks for a previous load from this source, and if it finds\n one, resumes that load job. If no previous load job is found, the loader stops.

    \n

    The loader avoids reloading files that were successfully loaded in\n a previous job. It only tries to process failed files. If you dropped\n previously loaded data from your Neptune cluster, that data is not\n reloaded in this mode. If a previous load job loaded all files from the\n same source successfully, nothing is reloaded, and the loader returns\n success.

    \n
    • \n
  • \n

    \n NEW   –   In NEW mode, the\n creates a new load request regardless of any previous loads. You\n can use this mode to reload all the data from a source after dropping\n previously loaded data from your Neptune cluster, or to load new data\n available at the same source.

    \n
    • \n
  • \n

    \n AUTO   –   In AUTO mode,\n the loader looks for a previous load job from the same source, and if it\n finds one, resumes that job, just as in RESUME mode.

    \n

    If the loader doesn't find a previous load job from the same\n source, it loads all data from the source, just as in NEW\n mode.

    \n
    • \n
" + "smithy.api#documentation": "

The load job mode.

Allowed values: RESUME, NEW, AUTO.

Default value: AUTO.

  • RESUME   –   In RESUME mode, the loader looks for a previous load from this source, and if it finds one, resumes that load job. If no previous load job is found, the loader stops.

    The loader avoids reloading files that were successfully loaded in a previous job. It only tries to process failed files. If you dropped previously loaded data from your Neptune cluster, that data is not reloaded in this mode. If a previous load job loaded all files from the same source successfully, nothing is reloaded, and the loader returns success.

  • NEW   –   In NEW mode, the creates a new load request regardless of any previous loads. You can use this mode to reload all the data from a source after dropping previously loaded data from your Neptune cluster, or to load new data available at the same source.

  • AUTO   –   In AUTO mode, the loader looks for a previous load job from the same source, and if it finds one, resumes that job, just as in RESUME mode.

    If the loader doesn't find a previous load job from the same source, it loads all data from the source, just as in NEW mode.

" } }, "failOnError": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

\n \n failOnError\n   –   A flag to toggle a\n complete stop on an error.

\n

\n Allowed values: \"TRUE\", \"FALSE\".

\n

\n Default value: \"TRUE\".

\n

When this parameter is set to \"FALSE\", the loader tries to load all\n the data in the location specified, skipping any entries with errors.

\n

When this parameter is set to \"TRUE\", the loader stops\n as soon as it encounters an error. Data loaded up to that point persists.

" + "smithy.api#documentation": "

failOnError   –   A flag to toggle a complete stop on an error.

Allowed values: \"TRUE\", \"FALSE\".

Default value: \"TRUE\".

When this parameter is set to \"FALSE\", the loader tries to load all the data in the location specified, skipping any entries with errors.

When this parameter is set to \"TRUE\", the loader stops as soon as it encounters an error. Data loaded up to that point persists.

" } }, "parallelism": { "target": "com.amazonaws.neptunedata#Parallelism", "traits": { - "smithy.api#documentation": "

The optional parallelism parameter can be set\n to reduce the number of threads used by the bulk load process.

\n

\n Allowed values:

\n
    \n
  • \n

    \n LOW –   The number of threads used is the\n number of available vCPUs divided by 8.

    \n
    • \n
  • \n

    \n MEDIUM –   The number of threads used is the\n number of available vCPUs divided by 2.

    \n
    • \n
  • \n

    \n HIGH –   The number of threads used is the\n same as the number of available vCPUs.

    \n
    • \n
  • \n

    \n OVERSUBSCRIBE –   The number of threads used is the\n number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all\n available resources.

    \n

    This does not mean, however, that the OVERSUBSCRIBE setting\n results in 100% CPU utilization. Because the load operation is I/O bound, the\n highest CPU utilization to expect is in the 60% to 70% range.

    \n
    • \n
\n

\n Default value: HIGH\n

\n

The parallelism setting can sometimes result in a deadlock\n between threads when loading openCypher data. When this happens, Neptune returns the\n LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting\n parallelism to a lower setting and retrying the load command.

" + "smithy.api#documentation": "

The optional parallelism parameter can be set to reduce the number of threads used by the bulk load process.

Allowed values:

  • LOW –   The number of threads used is the number of available vCPUs divided by 8.

  • MEDIUM –   The number of threads used is the number of available vCPUs divided by 2.

  • HIGH –   The number of threads used is the same as the number of available vCPUs.

  • OVERSUBSCRIBE –   The number of threads used is the number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all available resources.

    This does not mean, however, that the OVERSUBSCRIBE setting results in 100% CPU utilization. Because the load operation is I/O bound, the highest CPU utilization to expect is in the 60% to 70% range.

Default value: HIGH

The parallelism setting can sometimes result in a deadlock between threads when loading openCypher data. When this happens, Neptune returns the LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting parallelism to a lower setting and retrying the load command.

" } }, "parserConfiguration": { "target": "com.amazonaws.neptunedata#StringValuedMap", "traits": { - "smithy.api#documentation": "

\n \n parserConfiguration\n  \n –   An optional object with additional parser configuration values.\n Each of the child parameters is also optional:

\n

\n \n

\n
    \n
  • \n

    \n \n namedGraphUri\n   –  \n The default graph for all RDF formats when no graph is specified (for non-quads\n formats and NQUAD entries with no graph).

    \n

    The default is https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph.

    \n
    • \n
  • \n

    \n \n baseUri\n   –  \n The base URI for RDF/XML and Turtle formats.

    \n

    The default is https://aws.amazon.com/neptune/default.

    \n
    • \n
  • \n

    \n \n allowEmptyStrings\n   –  \n Gremlin users need to be able to pass empty string values(\"\") as node\n and edge properties when loading CSV data. If allowEmptyStrings\n is set to false (the default), such empty strings are treated\n as nulls and are not loaded.

    \n

    If allowEmptyStrings is set to true,\n the loader treats empty strings as valid property values and loads\n them accordingly.

    \n
    • \n
" + "smithy.api#documentation": "

parserConfiguration   –   An optional object with additional parser configuration values. Each of the child parameters is also optional:

  • namedGraphUri   –   The default graph for all RDF formats when no graph is specified (for non-quads formats and NQUAD entries with no graph).

    The default is https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph.

  • baseUri   –   The base URI for RDF/XML and Turtle formats.

    The default is https://aws.amazon.com/neptune/default.

  • allowEmptyStrings   –   Gremlin users need to be able to pass empty string values(\"\") as node and edge properties when loading CSV data. If allowEmptyStrings is set to false (the default), such empty strings are treated as nulls and are not loaded.

    If allowEmptyStrings is set to true, the loader treats empty strings as valid property values and loads them accordingly.

" } }, "updateSingleCardinalityProperties": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

\n updateSingleCardinalityProperties\n is an optional parameter that controls how the bulk loader treats a new\n value for single-cardinality vertex or edge properties. This is not supported for\n loading openCypher data.

\n

\n Allowed values: \"TRUE\", \"FALSE\".

\n

\n Default value: \"FALSE\".

\n

By default, or when updateSingleCardinalityProperties is explicitly\n set to \"FALSE\", the loader treats a new value as an error, because it\n violates single cardinality.

\n

When updateSingleCardinalityProperties is set to \"TRUE\",\n on the other hand, the bulk loader replaces the existing value with the new one.\n If multiple edge or single-cardinality vertex property values are provided in the\n source file(s) being loaded, the final value at the end of the bulk load could be\n any one of those new values. The loader only guarantees that the existing value\n has been replaced by one of the new ones.

" + "smithy.api#documentation": "

updateSingleCardinalityProperties is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties. This is not supported for loading openCypher data.

Allowed values: \"TRUE\", \"FALSE\".

Default value: \"FALSE\".

By default, or when updateSingleCardinalityProperties is explicitly set to \"FALSE\", the loader treats a new value as an error, because it violates single cardinality.

When updateSingleCardinalityProperties is set to \"TRUE\", on the other hand, the bulk loader replaces the existing value with the new one. If multiple edge or single-cardinality vertex property values are provided in the source file(s) being loaded, the final value at the end of the bulk load could be any one of those new values. The loader only guarantees that the existing value has been replaced by one of the new ones.

" } }, "queueRequest": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

This is an optional flag parameter\n that indicates whether the load request can be queued up or not.

\n

You don't have to wait for one load job to complete before issuing the next one,\n because Neptune can queue up as many as 64 jobs at a time, provided that their\n queueRequest parameters are all set to \"TRUE\".\n The queue order of the jobs will be first-in-first-out (FIFO).

\n

If the queueRequest parameter is omitted or set to \"FALSE\",\n the load request will fail if another load job is already running.

\n

\n Allowed values: \"TRUE\", \"FALSE\".

\n

\n Default value: \"FALSE\".

" + "smithy.api#documentation": "

This is an optional flag parameter that indicates whether the load request can be queued up or not.

You don't have to wait for one load job to complete before issuing the next one, because Neptune can queue up as many as 64 jobs at a time, provided that their queueRequest parameters are all set to \"TRUE\". The queue order of the jobs will be first-in-first-out (FIFO).

If the queueRequest parameter is omitted or set to \"FALSE\", the load request will fail if another load job is already running.

Allowed values: \"TRUE\", \"FALSE\".

Default value: \"FALSE\".

" } }, "dependencies": { "target": "com.amazonaws.neptunedata#StringList", "traits": { - "smithy.api#documentation": "

This is an optional parameter that can make a queued load request\n contingent on the successful completion of one or more previous jobs\n in the queue.

\n

Neptune can queue up as many as 64 load requests at a time, if their\n queueRequest parameters are set to \"TRUE\". The\n dependencies parameter lets you make execution of such a queued request\n dependent on the successful completion of one or more specified previous requests\n in the queue.

\n

For example, if load Job-A and Job-B are independent\n of each other, but load Job-C needs Job-A and Job-B\n to be finished before it begins, proceed as follows:

\n
    \n
  1. \n

    Submit load-job-A and load-job-B one after\n another in any order, and save their load-ids.

    \n
    2. \n
  2. \n

    Submit load-job-C with the load-ids of the\n two jobs in its dependencies field:

    \n
    3. \n
\n

Because of the dependencies parameter, the bulk loader will not start\n Job-C until Job-A and Job-B have completed\n successfully. If either one of them fails, Job-C will not be executed, and its\n status will be set to LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED.

\n

You can set up multiple levels of dependency in this way, so that the failure of one job\n will cause all requests that are directly or indirectly dependent on it to be cancelled.

" + "smithy.api#documentation": "

This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.

Neptune can queue up as many as 64 load requests at a time, if their queueRequest parameters are set to \"TRUE\". The dependencies parameter lets you make execution of such a queued request dependent on the successful completion of one or more specified previous requests in the queue.

For example, if load Job-A and Job-B are independent of each other, but load Job-C needs Job-A and Job-B to be finished before it begins, proceed as follows:

  1. Submit load-job-A and load-job-B one after another in any order, and save their load-ids.

  2. Submit load-job-C with the load-ids of the two jobs in its dependencies field:

Because of the dependencies parameter, the bulk loader will not start Job-C until Job-A and Job-B have completed successfully. If either one of them fails, Job-C will not be executed, and its status will be set to LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED.

You can set up multiple levels of dependency in this way, so that the failure of one job will cause all requests that are directly or indirectly dependent on it to be cancelled.

" } }, "userProvidedEdgeIds": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

This parameter is required only when loading openCypher data that contains relationship\n IDs. It must be included and set to True when openCypher relationship IDs\n are explicitly provided in the load data (recommended).

\n

When userProvidedEdgeIds is absent or set to True,\n an :ID column must be present in every relationship file in the load.

\n

When userProvidedEdgeIds is present and set to False,\n relationship files in the load must not contain an\n :ID column. Instead, the Neptune loader automatically generates an\n ID for each relationship.

\n

It's useful to provide relationship IDs explicitly so that the loader can resume\n loading after error in the CSV data have been fixed, without having to reload any\n relationships that have already been loaded. If relationship IDs have not been\n explicitly assigned, the loader cannot resume a failed load if any relationship file\n has had to be corrected, and must instead reload all the relationships.

" + "smithy.api#documentation": "

This parameter is required only when loading openCypher data that contains relationship IDs. It must be included and set to True when openCypher relationship IDs are explicitly provided in the load data (recommended).

When userProvidedEdgeIds is absent or set to True, an :ID column must be present in every relationship file in the load.

When userProvidedEdgeIds is present and set to False, relationship files in the load must not contain an :ID column. Instead, the Neptune loader automatically generates an ID for each relationship.

It's useful to provide relationship IDs explicitly so that the loader can resume loading after error in the CSV data have been fixed, without having to reload any relationships that have already been loaded. If relationship IDs have not been explicitly assigned, the loader cannot resume a failed load if any relationship file has had to be corrected, and must instead reload all the relationships.

" } } }, @@ -7149,7 +7227,7 @@ "payload": { "target": "com.amazonaws.neptunedata#StringValuedMap", "traits": { - "smithy.api#documentation": "

Contains a loadId name-value pair that provides an identifier\n for the load operation.

", + "smithy.api#documentation": "

Contains a loadId name-value pair that provides an identifier for the load operation.

", "smithy.api#required": {} } } @@ -7202,7 +7280,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Neptune ML data processing job for processing the\n graph data exported from Neptune for training. See The\n dataprocessing command.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:StartMLModelDataProcessingJob\n IAM action in that cluster.

", + "smithy.api#documentation": "

Creates a new Neptune ML data processing job for processing the graph data exported from Neptune for training. See The dataprocessing command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelDataProcessingJob IAM action in that cluster.

", "smithy.api#http": { "method": "POST", "uri": "/ml/dataprocessing", @@ -7228,39 +7306,39 @@ "inputDataS3Location": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The URI of the Amazon S3 location where you want SageMaker to download\n the data needed to run the data processing job.

", + "smithy.api#documentation": "

The URI of the Amazon S3 location where you want SageMaker to download the data needed to run the data processing job.

", "smithy.api#required": {} } }, "processedDataS3Location": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The URI of the Amazon S3 location where you want SageMaker to save the\n results of a data processing job.

", + "smithy.api#documentation": "

The URI of the Amazon S3 location where you want SageMaker to save the results of a data processing job.

", "smithy.api#required": {} } }, "sagemakerIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role for SageMaker execution.\n This must be listed in your DB cluster parameter group or an error will occur.

" + "smithy.api#documentation": "

The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.

" } }, "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume\n to perform tasks on your behalf. This must be listed in your DB cluster\n parameter group or an error will occur.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf. This must be listed in your DB cluster parameter group or an error will occur.

" } }, "processingInstanceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The type of ML instance used during data processing. Its memory\n should be large enough to hold the processed dataset. The default is\n the smallest ml.r5 type whose memory is ten times larger than the size\n of the exported graph data on disk.

" + "smithy.api#documentation": "

The type of ML instance used during data processing. Its memory should be large enough to hold the processed dataset. The default is the smallest ml.r5 type whose memory is ten times larger than the size of the exported graph data on disk.

" } }, "processingInstanceVolumeSizeInGB": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The disk volume size of the processing instance. Both input data\n and processed data are stored on disk, so the volume size must be large\n enough to hold both data sets. The default is 0. If not specified or 0,\n Neptune ML chooses the volume size automatically based on the data size.

" + "smithy.api#documentation": "

The disk volume size of the processing instance. Both input data and processed data are stored on disk, so the volume size must be large enough to hold both data sets. The default is 0. If not specified or 0, Neptune ML chooses the volume size automatically based on the data size.

" } }, "processingTimeOutInSeconds": { @@ -7272,13 +7350,13 @@ "modelType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

One of the two model types that Neptune ML currently supports:\n heterogeneous graph models (heterogeneous), and knowledge\n graph (kge). The default is none. If not specified,\n Neptune ML chooses the model type automatically based on the data.

" + "smithy.api#documentation": "

One of the two model types that Neptune ML currently supports: heterogeneous graph models (heterogeneous), and knowledge graph (kge). The default is none. If not specified, Neptune ML chooses the model type automatically based on the data.

" } }, "configFileName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A data specification file that describes how to load the exported\n graph data for training. The file is automatically generated by the\n Neptune export toolkit. The default is\n training-data-configuration.json.

" + "smithy.api#documentation": "

A data specification file that describes how to load the exported graph data for training. The file is automatically generated by the Neptune export toolkit. The default is training-data-configuration.json.

" } }, "subnets": { @@ -7296,13 +7374,13 @@ "volumeEncryptionKMSKey": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to\n encrypt data on the storage volume attached to the ML compute instances\n that run the training job. The default is None.

" + "smithy.api#documentation": "

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

" } }, "s3OutputEncryptionKMSKey": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses\n to encrypt the output of the processing job. The default is none.

" + "smithy.api#documentation": "

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.

" } } }, @@ -7380,7 +7458,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Neptune ML model training job. See Model\n training using the modeltraining command.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:StartMLModelTrainingJob\n IAM action in that cluster.

", + "smithy.api#documentation": "

Creates a new Neptune ML model training job. See Model training using the modeltraining command.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelTrainingJob IAM action in that cluster.

", "smithy.api#http": { "method": "POST", "uri": "/ml/modeltraining", @@ -7400,13 +7478,13 @@ "previousModelTrainingJobId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The job ID of a completed model-training job that you want to update\n incrementally based on updated data.

" + "smithy.api#documentation": "

The job ID of a completed model-training job that you want to update incrementally based on updated data.

" } }, "dataProcessingJobId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The job ID of the completed data-processing job that has created\n the data that the training will work with.

", + "smithy.api#documentation": "

The job ID of the completed data-processing job that has created the data that the training will work with.

", "smithy.api#required": {} } }, @@ -7420,31 +7498,31 @@ "sagemakerIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role for SageMaker execution.This must be listed\n in your DB cluster parameter group or an error will occur.

" + "smithy.api#documentation": "

The ARN of an IAM role for SageMaker execution.This must be listed in your DB cluster parameter group or an error will occur.

" } }, "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

" + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

" } }, "baseProcessingInstanceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The type of ML instance used in preparing and managing training\n of ML models. This is a CPU instance chosen based on memory requirements\n for processing the training data and model.

" + "smithy.api#documentation": "

The type of ML instance used in preparing and managing training of ML models. This is a CPU instance chosen based on memory requirements for processing the training data and model.

" } }, "trainingInstanceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The type of ML instance used for model training. All Neptune ML\n models support CPU, GPU, and multiGPU training. The default is\n ml.p3.2xlarge. Choosing the right instance type for\n training depends on the task type, graph size, and your budget.

" + "smithy.api#documentation": "

The type of ML instance used for model training. All Neptune ML models support CPU, GPU, and multiGPU training. The default is ml.p3.2xlarge. Choosing the right instance type for training depends on the task type, graph size, and your budget.

" } }, "trainingInstanceVolumeSizeInGB": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The disk volume size of the training instance. Both input data\n and the output model are stored on disk, so the volume size must be\n large enough to hold both data sets. The default is 0. If not specified\n or 0, Neptune ML selects a disk volume size based on the recommendation\n generated in the data processing step.

" + "smithy.api#documentation": "

The disk volume size of the training instance. Both input data and the output model are stored on disk, so the volume size must be large enough to hold both data sets. The default is 0. If not specified or 0, Neptune ML selects a disk volume size based on the recommendation generated in the data processing step.

" } }, "trainingTimeOutInSeconds": { @@ -7456,13 +7534,13 @@ "maxHPONumberOfTrainingJobs": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Maximum total number of training jobs to start for the hyperparameter\n tuning job. The default is 2. Neptune ML automatically tunes the hyperparameters\n of the machine learning model. To obtain a model that performs well, use at\n least 10 jobs (in other words, set maxHPONumberOfTrainingJobs to 10).\n In general, the more tuning runs, the better the results.

" + "smithy.api#documentation": "

Maximum total number of training jobs to start for the hyperparameter tuning job. The default is 2. Neptune ML automatically tunes the hyperparameters of the machine learning model. To obtain a model that performs well, use at least 10 jobs (in other words, set maxHPONumberOfTrainingJobs to 10). In general, the more tuning runs, the better the results.

" } }, "maxHPOParallelTrainingJobs": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Maximum number of parallel training jobs to start for the hyperparameter\n tuning job. The default is 2. The number of parallel jobs you can run is\n limited by the available resources on your training instance.

" + "smithy.api#documentation": "

Maximum number of parallel training jobs to start for the hyperparameter tuning job. The default is 2. The number of parallel jobs you can run is limited by the available resources on your training instance.

" } }, "subnets": { @@ -7480,19 +7558,19 @@ "volumeEncryptionKMSKey": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Key Management Service (KMS) key that SageMaker uses to\n encrypt data on the storage volume attached to the ML compute instances\n that run the training job. The default is None.

" + "smithy.api#documentation": "

The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

" } }, "s3OutputEncryptionKMSKey": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Key Management Service (KMS) key that SageMaker uses\n to encrypt the output of the processing job. The default is none.

" + "smithy.api#documentation": "

The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.

" } }, "enableManagedSpotTraining": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Optimizes the cost of training machine-learning models by using\n Amazon Elastic Compute Cloud spot instances. The default is False.

" + "smithy.api#documentation": "

Optimizes the cost of training machine-learning models by using Amazon Elastic Compute Cloud spot instances. The default is False.

" } }, "customModelTrainingParameters": { @@ -7576,7 +7654,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new model transform job. See Use\n a trained model to generate new model artifacts.

\n

When invoking this operation in a Neptune cluster that has IAM\n authentication enabled, the IAM user or role making the request must\n have a policy attached that allows the neptune-db:StartMLModelTransformJob\n IAM action in that cluster.

", + "smithy.api#documentation": "

Creates a new model transform job. See Use a trained model to generate new model artifacts.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelTransformJob IAM action in that cluster.

", "smithy.api#http": { "method": "POST", "uri": "/ml/modeltransform", @@ -7596,19 +7674,19 @@ "dataProcessingJobId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The job ID of a completed data-processing job. You must include either\n dataProcessingJobId and a mlModelTrainingJobId,\n or a trainingJobName.

" + "smithy.api#documentation": "

The job ID of a completed data-processing job. You must include either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.

" } }, "mlModelTrainingJobId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The job ID of a completed model-training job. You must include either\n dataProcessingJobId and a mlModelTrainingJobId,\n or a trainingJobName.

" + "smithy.api#documentation": "

The job ID of a completed model-training job. You must include either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.

" } }, "trainingJobName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of a completed SageMaker training job. You must include either\n dataProcessingJobId and a mlModelTrainingJobId,\n or a trainingJobName.

" + "smithy.api#documentation": "

The name of a completed SageMaker training job. You must include either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.

" } }, "modelTransformOutputS3Location": { @@ -7621,31 +7699,31 @@ "sagemakerIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role for SageMaker execution. This must be listed\n in your DB cluster parameter group or an error will occur.

" + "smithy.api#documentation": "

The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.

" } }, "neptuneIamRoleArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

" + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

" } }, "customModelTransformParameters": { "target": "com.amazonaws.neptunedata#CustomModelTransformParameters", "traits": { - "smithy.api#documentation": "

Configuration information for a model transform using a custom model.\n The customModelTransformParameters object contains the following\n fields, which must have values compatible with the saved model parameters from\n the training job:

" + "smithy.api#documentation": "

Configuration information for a model transform using a custom model. The customModelTransformParameters object contains the following fields, which must have values compatible with the saved model parameters from the training job:

" } }, "baseProcessingInstanceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The type of ML instance used in preparing and managing training of ML models.\n This is an ML compute instance chosen based on memory requirements for processing\n the training data and model.

" + "smithy.api#documentation": "

The type of ML instance used in preparing and managing training of ML models. This is an ML compute instance chosen based on memory requirements for processing the training data and model.

" } }, "baseProcessingInstanceVolumeSizeInGB": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The disk volume size of the training instance in gigabytes. The default is 0.\n Both input data and the output model are stored on disk, so the volume size must\n be large enough to hold both data sets. If not specified or 0, Neptune ML selects\n a disk volume size based on the recommendation generated in the data processing step.

" + "smithy.api#documentation": "

The disk volume size of the training instance in gigabytes. The default is 0. Both input data and the output model are stored on disk, so the volume size must be large enough to hold both data sets. If not specified or 0, Neptune ML selects a disk volume size based on the recommendation generated in the data processing step.

" } }, "subnets": { @@ -7663,13 +7741,13 @@ "volumeEncryptionKMSKey": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data\n on the storage volume attached to the ML compute instances that run the training job.\n The default is None.

" + "smithy.api#documentation": "

The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

" } }, "s3OutputEncryptionKMSKey": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Key Management Service (KMS) key that SageMaker uses to\n encrypt the output of the processing job. The default is none.

" + "smithy.api#documentation": "

The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.

" } } }, @@ -7721,7 +7799,7 @@ "statisticsId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Reports the ID of the current statistics generation run.\n A value of -1 indicates that no statistics have been generated.

" + "smithy.api#documentation": "

Reports the ID of the current statistics generation run. A value of -1 indicates that no statistics have been generated.

" } }, "date": { @@ -7740,12 +7818,12 @@ "signatureInfo": { "target": "com.amazonaws.neptunedata#StatisticsSummary", "traits": { - "smithy.api#documentation": "

A StatisticsSummary structure that contains:

\n
    \n
  • \n

    \n signatureCount - The total number of signatures\n across all characteristic sets.

    \n
    • \n
  • \n

    \n instanceCount - The total number of\n characteristic-set instances.

    \n
    • \n
  • \n

    \n predicateCount - The total number of unique predicates.

    \n
    • \n
" + "smithy.api#documentation": "

A StatisticsSummary structure that contains:

  • signatureCount - The total number of signatures across all characteristic sets.

  • instanceCount - The total number of characteristic-set instances.

  • predicateCount - The total number of unique predicates.

" } } }, "traits": { - "smithy.api#documentation": "

Contains statistics information. The DFE engine uses information\n about the data in your Neptune graph to make effective trade-offs when\n planning query execution. This information takes the form of statistics\n that include so-called characteristic sets and predicate statistics\n that can guide query planning. See Managing\n statistics for the Neptune DFE to use.

" + "smithy.api#documentation": "

Contains statistics information. The DFE engine uses information about the data in your Neptune graph to make effective trade-offs when planning query execution. This information takes the form of statistics that include so-called characteristic sets and predicate statistics that can guide query planning. See Managing statistics for the Neptune DFE to use.

" } }, "com.amazonaws.neptunedata#StatisticsAutoGenerationMode": { @@ -7926,7 +8004,7 @@ } }, "traits": { - "smithy.api#documentation": "

Raised when the rate of requests exceeds the maximum throughput. Requests can\n be retried after encountering this exception.

", + "smithy.api#documentation": "

Raised when the rate of requests exceeds the maximum throughput. Requests can be retried after encountering this exception.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} diff --git a/codegen/sdk/aws-models/observabilityadmin.json b/codegen/sdk/aws-models/observabilityadmin.json index 29a51cb81a1..375e8720fc4 100644 --- a/codegen/sdk/aws-models/observabilityadmin.json +++ b/codegen/sdk/aws-models/observabilityadmin.json @@ -16,7 +16,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.\n

", + "smithy.api#documentation": "

\n Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for Amazon Web Services resources in the IAM user guide.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -38,12 +38,288 @@ }, "traits": { "smithy.api#length": { - "min": 0, + "min": 1, "max": 10 }, "smithy.api#uniqueItems": {} } }, + "com.amazonaws.observabilityadmin#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

\n The requested operation conflicts with the current state of the specified resource or with another request.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.observabilityadmin#CreateTelemetryRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#CreateTelemetryRuleInput" + }, + "output": { + "target": "com.amazonaws.observabilityadmin#CreateTelemetryRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.observabilityadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.observabilityadmin#ConflictException" + }, + { + "target": "com.amazonaws.observabilityadmin#InternalServerException" + }, + { + "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, + { + "target": "com.amazonaws.observabilityadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Creates a telemetry rule that defines how telemetry should be configured for Amazon Web Services resources in your account. The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/CreateTelemetryRule" + } + } + }, + "com.amazonaws.observabilityadmin#CreateTelemetryRuleForOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#CreateTelemetryRuleForOrganizationInput" + }, + "output": { + "target": "com.amazonaws.observabilityadmin#CreateTelemetryRuleForOrganizationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.observabilityadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.observabilityadmin#ConflictException" + }, + { + "target": "com.amazonaws.observabilityadmin#InternalServerException" + }, + { + "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, + { + "target": "com.amazonaws.observabilityadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Creates a telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/CreateTelemetryRuleForOrganization" + } + } + }, + "com.amazonaws.observabilityadmin#CreateTelemetryRuleForOrganizationInput": { + "type": "structure", + "members": { + "RuleName": { + "target": "com.amazonaws.observabilityadmin#RuleName", + "traits": { + "smithy.api#documentation": "

\n A unique name for the organization-wide telemetry rule being created.\n

", + "smithy.api#required": {} + } + }, + "Rule": { + "target": "com.amazonaws.observabilityadmin#TelemetryRule", + "traits": { + "smithy.api#documentation": "

\n The configuration details for the organization-wide telemetry rule, including the resource type, telemetry type, destination configuration, and selection criteria for which resources the rule applies to across the organization.\n

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.observabilityadmin#TagMapInput", + "traits": { + "smithy.api#documentation": "

\n The key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#CreateTelemetryRuleForOrganizationOutput": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the created organization telemetry rule.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.observabilityadmin#CreateTelemetryRuleInput": { + "type": "structure", + "members": { + "RuleName": { + "target": "com.amazonaws.observabilityadmin#RuleName", + "traits": { + "smithy.api#documentation": "

\n A unique name for the telemetry rule being created.\n

", + "smithy.api#required": {} + } + }, + "Rule": { + "target": "com.amazonaws.observabilityadmin#TelemetryRule", + "traits": { + "smithy.api#documentation": "

\n The configuration details for the telemetry rule, including the resource type, telemetry type, destination configuration, and selection criteria for which resources the rule applies to.\n

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.observabilityadmin#TagMapInput", + "traits": { + "smithy.api#documentation": "

\n The key-value pairs to associate with the telemetry rule resource for categorization and management purposes.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#CreateTelemetryRuleOutput": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the created telemetry rule.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.observabilityadmin#DeleteTelemetryRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#DeleteTelemetryRuleInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.observabilityadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.observabilityadmin#InternalServerException" + }, + { + "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, + { + "target": "com.amazonaws.observabilityadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Deletes a telemetry rule from your account. Any telemetry configurations previously created by the rule will remain but no new resources will be configured by this rule.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteTelemetryRule" + } + } + }, + "com.amazonaws.observabilityadmin#DeleteTelemetryRuleForOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#DeleteTelemetryRuleForOrganizationInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.observabilityadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.observabilityadmin#InternalServerException" + }, + { + "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, + { + "target": "com.amazonaws.observabilityadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Deletes an organization-wide telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteTelemetryRuleForOrganization" + } + } + }, + "com.amazonaws.observabilityadmin#DeleteTelemetryRuleForOrganizationInput": { + "type": "structure", + "members": { + "RuleIdentifier": { + "target": "com.amazonaws.observabilityadmin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "

\n The identifier (name or ARN) of the organization telemetry rule to delete.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#DeleteTelemetryRuleInput": { + "type": "structure", + "members": { + "RuleIdentifier": { + "target": "com.amazonaws.observabilityadmin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "

\n The identifier (name or ARN) of the telemetry rule to delete.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#DestinationType": { + "type": "enum", + "members": { + "CLOUDWATCH_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cloud-watch-logs" + } + } + } + }, "com.amazonaws.observabilityadmin#FailureReason": { "type": "string" }, @@ -61,6 +337,9 @@ }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" } ], "traits": { @@ -75,9 +354,7 @@ "id": "GetTelemetryEvaluationStatus", "params": {}, "expect": { - "failure": { - "errorId": "com.amazonaws.observabilityadmin#AccessDeniedException" - } + "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { @@ -102,12 +379,15 @@ { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { - "smithy.api#documentation": "

\n This returns the onboarding status of the telemetry configuration feature for the organization. It can only be called by a Management Account of an AWS Organization or an assigned Delegated Admin Account of AWS CloudWatch telemetry config.\n

", + "smithy.api#documentation": "

\n This returns the onboarding status of the telemetry configuration feature for the organization. It can only be called by a Management Account of an Amazon Web Services Organization or an assigned Delegated Admin Account of Amazon CloudWatch telemetry config.\n

", "smithy.api#http": { "method": "POST", "uri": "/GetTelemetryEvaluationStatusForOrganization" @@ -170,33 +450,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.observabilityadmin#InternalServerException": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String" - }, - "amznErrorType": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

\n The name of the exception.\n

", - "smithy.api#httpHeader": "x-amzn-ErrorType" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Indicates the request has failed to process because of an unknown server error, exception, or failure.\n

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.observabilityadmin#ListResourceTelemetry": { + "com.amazonaws.observabilityadmin#GetTelemetryRule": { "type": "operation", "input": { - "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryInput" + "target": "com.amazonaws.observabilityadmin#GetTelemetryRuleInput" }, "output": { - "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryOutput" + "target": "com.amazonaws.observabilityadmin#GetTelemetryRuleOutput" }, "errors": [ { @@ -205,32 +465,32 @@ { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, + { + "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { - "smithy.api#documentation": "

\n Returns a list of telemetry configurations for AWS resources supported by telemetry config. For more information, see Auditing CloudWatch telemetry configurations.\n

", + "smithy.api#documentation": "

\n Retrieves the details of a specific telemetry rule in your account.\n

", "smithy.api#http": { "method": "POST", - "uri": "/ListResourceTelemetry" - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults", - "items": "TelemetryConfigurations" + "uri": "/GetTelemetryRule" }, "smithy.api#readonly": {} } }, - "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganization": { + "com.amazonaws.observabilityadmin#GetTelemetryRuleForOrganization": { "type": "operation", "input": { - "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganizationInput" + "target": "com.amazonaws.observabilityadmin#GetTelemetryRuleForOrganizationInput" }, "output": { - "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganizationOutput" + "target": "com.amazonaws.observabilityadmin#GetTelemetryRuleForOrganizationOutput" }, "errors": [ { @@ -239,19 +499,219 @@ { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, + { + "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { - "smithy.api#documentation": "

\n Returns a list of telemetry configurations for AWS resources supported by telemetry config in the organization.\n

", + "smithy.api#documentation": "

\n Retrieves the details of a specific organization telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.\n

", "smithy.api#http": { "method": "POST", - "uri": "/ListResourceTelemetryForOrganization" + "uri": "/GetTelemetryRuleForOrganization" }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.observabilityadmin#GetTelemetryRuleForOrganizationInput": { + "type": "structure", + "members": { + "RuleIdentifier": { + "target": "com.amazonaws.observabilityadmin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "

\n The identifier (name or ARN) of the organization telemetry rule to retrieve.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#GetTelemetryRuleForOrganizationOutput": { + "type": "structure", + "members": { + "RuleName": { + "target": "com.amazonaws.observabilityadmin#RuleName", + "traits": { + "smithy.api#documentation": "

\n The name of the organization telemetry rule.\n

" + } + }, + "RuleArn": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the organization telemetry rule.\n

" + } + }, + "CreatedTimeStamp": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the organization telemetry rule was created.\n

" + } + }, + "LastUpdateTimeStamp": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the organization telemetry rule was last updated.\n

" + } + }, + "TelemetryRule": { + "target": "com.amazonaws.observabilityadmin#TelemetryRule", + "traits": { + "smithy.api#documentation": "

\n The configuration details of the organization telemetry rule.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.observabilityadmin#GetTelemetryRuleInput": { + "type": "structure", + "members": { + "RuleIdentifier": { + "target": "com.amazonaws.observabilityadmin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "

\n The identifier (name or ARN) of the telemetry rule to retrieve.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#GetTelemetryRuleOutput": { + "type": "structure", + "members": { + "RuleName": { + "target": "com.amazonaws.observabilityadmin#RuleName", + "traits": { + "smithy.api#documentation": "

\n The name of the telemetry rule.\n

" + } + }, + "RuleArn": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the telemetry rule.\n

" + } + }, + "CreatedTimeStamp": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the telemetry rule was created.\n

" + } + }, + "LastUpdateTimeStamp": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the telemetry rule was last updated.\n

" + } + }, + "TelemetryRule": { + "target": "com.amazonaws.observabilityadmin#TelemetryRule", + "traits": { + "smithy.api#documentation": "

\n The configuration details of the telemetry rule.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.observabilityadmin#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + }, + "amznErrorType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The name of the exception.\n

", + "smithy.api#httpHeader": "x-amzn-ErrorType" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Indicates the request has failed to process because of an unknown server error, exception, or failure.\n

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.observabilityadmin#ListResourceTelemetry": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryInput" + }, + "output": { + "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.observabilityadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.observabilityadmin#InternalServerException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, + { + "target": "com.amazonaws.observabilityadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config. For more information, see Auditing CloudWatch telemetry configurations.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListResourceTelemetry" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "TelemetryConfigurations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganizationInput" + }, + "output": { + "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganizationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.observabilityadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.observabilityadmin#InternalServerException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, + { + "target": "com.amazonaws.observabilityadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListResourceTelemetryForOrganization" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", "pageSize": "MaxResults", "items": "TelemetryConfigurations" }, @@ -264,7 +724,7 @@ "AccountIdentifiers": { "target": "com.amazonaws.observabilityadmin#AccountIdentifiers", "traits": { - "smithy.api#documentation": "

\n A list of AWS account IDs used to filter the resources to those associated with the specified accounts.\n

" + "smithy.api#documentation": "

\n A list of Amazon Web Services accounts used to filter the resources to those associated with the specified accounts.\n

" } }, "ResourceIdentifierPrefix": { @@ -324,7 +784,7 @@ "TelemetryConfigurations": { "target": "com.amazonaws.observabilityadmin#TelemetryConfigurations", "traits": { - "smithy.api#documentation": "

\n A list of telemetry configurations for AWS resources supported by telemetry config in the organization.\n

" + "smithy.api#documentation": "

\n A list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization.\n

" } }, "NextToken": { @@ -398,7 +858,7 @@ "TelemetryConfigurations": { "target": "com.amazonaws.observabilityadmin#TelemetryConfigurations", "traits": { - "smithy.api#documentation": "

\n A list of telemetry configurations for AWS resources supported by telemetry config in the caller's account.\n

" + "smithy.api#documentation": "

\n A list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the caller's account.\n

" } }, "NextToken": { @@ -412,72 +872,372 @@ "smithy.api#output": {} } }, - "com.amazonaws.observabilityadmin#NextToken": { - "type": "string" - }, - "com.amazonaws.observabilityadmin#ObservabilityAdmin": { - "type": "service", - "version": "2018-05-10", - "operations": [ + "com.amazonaws.observabilityadmin#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.observabilityadmin#ListTagsForResourceOutput" + }, + "errors": [ { - "target": "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatus" + "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { - "target": "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatusForOrganization" + "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { - "target": "com.amazonaws.observabilityadmin#ListResourceTelemetry" + "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { - "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganization" + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { - "target": "com.amazonaws.observabilityadmin#StartTelemetryEvaluation" + "target": "com.amazonaws.observabilityadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Lists all tags attached to the specified telemetry rule resource.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListTagsForResource" + } + } + }, + "com.amazonaws.observabilityadmin#ListTagsForResourceInput": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the telemetry rule resource whose tags you want to list.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.observabilityadmin#TagMapOutput", + "traits": { + "smithy.api#documentation": "

\n The list of tags associated with the telemetry rule resource.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.observabilityadmin#ListTelemetryRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesInput" + }, + "output": { + "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { - "target": "com.amazonaws.observabilityadmin#StartTelemetryEvaluationForOrganization" + "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { - "target": "com.amazonaws.observabilityadmin#StopTelemetryEvaluation" + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { - "target": "com.amazonaws.observabilityadmin#StopTelemetryEvaluationForOrganization" + "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { - "aws.api#service": { - "sdkId": "ObservabilityAdmin", - "arnNamespace": "observabilityadmin" + "smithy.api#documentation": "

\n Lists all telemetry rules in your account. You can filter the results by specifying a rule name prefix.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListTelemetryRules" }, - "aws.auth#sigv4": { - "name": "observabilityadmin" + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "TelemetryRuleSummaries" }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

\n Amazon CloudWatch Obsersavability Admin to control temletry config for your AWS Organization or account. Telemetry config config to discover and understand the state of telemetry configuration for your AWS resources from a central view in the CloudWatch console. Telemetry config simplifies the process of auditing your telemetry collection configurations across multiple resource types across your AWS Organization or account. \n For more information, see Auditing CloudWatch telemetry configurations in the CloudWatch User Guide.

\n

For information on the permissions you need to use this API, see Identity and access management for Amazon CloudWatch in the CloudWatch User Guide.

", - "smithy.api#title": "CloudWatch Observability Admin 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" - }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganizationInput" + }, + "output": { + "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganizationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.observabilityadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.observabilityadmin#InternalServerException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, + { + "target": "com.amazonaws.observabilityadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Lists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListTelemetryRulesForOrganization" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "TelemetryRuleSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganizationInput": { + "type": "structure", + "members": { + "RuleNamePrefix": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n A string to filter organization telemetry rules whose names begin with the specified prefix.\n

" + } + }, + "SourceAccountIds": { + "target": "com.amazonaws.observabilityadmin#AccountIdentifiers", + "traits": { + "smithy.api#documentation": "

\n The list of account IDs to filter organization telemetry rules by their source accounts.\n

" + } + }, + "SourceOrganizationUnitIds": { + "target": "com.amazonaws.observabilityadmin#OrganizationUnitIdentifiers", + "traits": { + "smithy.api#documentation": "

\n The list of organizational unit IDs to filter organization telemetry rules by their source organizational units.\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganizationMaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

\n The maximum number of organization telemetry rules to return in a single call.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.observabilityadmin#NextToken", + "traits": { + "smithy.api#documentation": "

\n The token for the next set of results. A previous call generates this token.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganizationMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganizationOutput": { + "type": "structure", + "members": { + "TelemetryRuleSummaries": { + "target": "com.amazonaws.observabilityadmin#TelemetryRuleSummaries", + "traits": { + "smithy.api#documentation": "

\n A list of organization telemetry rule summaries.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.observabilityadmin#NextToken", + "traits": { + "smithy.api#documentation": "

\n A token to resume pagination of results.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.observabilityadmin#ListTelemetryRulesInput": { + "type": "structure", + "members": { + "RuleNamePrefix": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n A string to filter telemetry rules whose names begin with the specified prefix.\n

" + } + }, + "MaxResults": { + "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesMaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

\n The maximum number of telemetry rules to return in a single call.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.observabilityadmin#NextToken", + "traits": { + "smithy.api#documentation": "

\n The token for the next set of results. A previous call generates this token.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#ListTelemetryRulesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.observabilityadmin#ListTelemetryRulesOutput": { + "type": "structure", + "members": { + "TelemetryRuleSummaries": { + "target": "com.amazonaws.observabilityadmin#TelemetryRuleSummaries", + "traits": { + "smithy.api#documentation": "

\n A list of telemetry rule summaries.\n

" + } + }, + "NextToken": { + "target": "com.amazonaws.observabilityadmin#NextToken", + "traits": { + "smithy.api#documentation": "

\n A token to resume pagination of results.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.observabilityadmin#NextToken": { + "type": "string" + }, + "com.amazonaws.observabilityadmin#ObservabilityAdmin": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.observabilityadmin#CreateTelemetryRule" + }, + { + "target": "com.amazonaws.observabilityadmin#CreateTelemetryRuleForOrganization" + }, + { + "target": "com.amazonaws.observabilityadmin#DeleteTelemetryRule" + }, + { + "target": "com.amazonaws.observabilityadmin#DeleteTelemetryRuleForOrganization" + }, + { + "target": "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatus" + }, + { + "target": "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatusForOrganization" + }, + { + "target": "com.amazonaws.observabilityadmin#GetTelemetryRule" + }, + { + "target": "com.amazonaws.observabilityadmin#GetTelemetryRuleForOrganization" + }, + { + "target": "com.amazonaws.observabilityadmin#ListResourceTelemetry" + }, + { + "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganization" + }, + { + "target": "com.amazonaws.observabilityadmin#ListTagsForResource" + }, + { + "target": "com.amazonaws.observabilityadmin#ListTelemetryRules" + }, + { + "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganization" + }, + { + "target": "com.amazonaws.observabilityadmin#StartTelemetryEvaluation" + }, + { + "target": "com.amazonaws.observabilityadmin#StartTelemetryEvaluationForOrganization" + }, + { + "target": "com.amazonaws.observabilityadmin#StopTelemetryEvaluation" + }, + { + "target": "com.amazonaws.observabilityadmin#StopTelemetryEvaluationForOrganization" + }, + { + "target": "com.amazonaws.observabilityadmin#TagResource" + }, + { + "target": "com.amazonaws.observabilityadmin#UntagResource" + }, + { + "target": "com.amazonaws.observabilityadmin#UpdateTelemetryRule" + }, + { + "target": "com.amazonaws.observabilityadmin#UpdateTelemetryRuleForOrganization" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "ObservabilityAdmin", + "arnNamespace": "observabilityadmin" + }, + "aws.auth#sigv4": { + "name": "observabilityadmin" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

\n You can use Amazon CloudWatch Observability Admin to discover and understand the state of telemetry configuration in CloudWatch for your Amazon Web Services Organization or account. This simplifies the process of auditing your telemetry collection configurations across multiple resource types within your Amazon Web Services Organization or account. By providing a consolidated view, it allows you to easily review and manage telemetry settings, helping you ensure proper monitoring and data collection across your Amazon Web Services environment. \n For more information, see Auditing CloudWatch telemetry configurations in the CloudWatch User Guide.

\n

For information on the permissions you need to use this API, see Identity and access management for Amazon CloudWatch in the CloudWatch User Guide.

", + "smithy.api#title": "CloudWatch Observability Admin 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, @@ -1121,6 +1881,34 @@ } } }, + "com.amazonaws.observabilityadmin#OrganizationUnitIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$" + } + }, + "com.amazonaws.observabilityadmin#OrganizationUnitIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.observabilityadmin#OrganizationUnitIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.observabilityadmin#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws:([a-zA-Z0-9\\-]+):([a-z0-9\\-]+)?:([0-9]{12})?:(.+)$" + } + }, "com.amazonaws.observabilityadmin#ResourceIdentifier": { "type": "string" }, @@ -1133,6 +1921,19 @@ } } }, + "com.amazonaws.observabilityadmin#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

\n The specified resource (such as a telemetry rule) could not be found.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.observabilityadmin#ResourceType": { "type": "enum", "members": { @@ -1164,32 +1965,83 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 5 + "max": 9 }, "smithy.api#uniqueItems": {} } }, - "com.amazonaws.observabilityadmin#StartTelemetryEvaluation": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ + "com.amazonaws.observabilityadmin#RetentionPeriodInDays": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 3653 + } + } + }, + "com.amazonaws.observabilityadmin#RuleIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, + "com.amazonaws.observabilityadmin#RuleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9A-Za-z-]+$" + } + }, + "com.amazonaws.observabilityadmin#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + }, + "amznErrorType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The name of the exception.\n

", + "smithy.api#httpHeader": "x-amzn-ErrorType" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The requested operation would exceed the allowed quota for the specified resource type.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.observabilityadmin#StartTelemetryEvaluation": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { - "smithy.api#documentation": "

\n This action begins onboarding onboarding the caller AWS account to the telemetry config feature.\n

", + "smithy.api#documentation": "

\n This action begins onboarding the caller Amazon Web Services account to the telemetry config feature.\n

", "smithy.api#http": { "method": "POST", "uri": "/StartTelemetryEvaluation" @@ -1211,6 +2063,9 @@ { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } @@ -1285,12 +2140,15 @@ { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { - "smithy.api#documentation": "

\n This action begins offboarding the caller AWS account from the telemetry config feature.\n

", + "smithy.api#documentation": "

\n This action begins offboarding the caller Amazon Web Services account from the telemetry config feature.\n

", "smithy.api#http": { "method": "POST", "uri": "/StopTelemetryEvaluation" @@ -1312,12 +2170,15 @@ { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { - "smithy.api#documentation": "

\n This action offboards the Organization of the caller AWS account from thef telemetry config feature.\n

", + "smithy.api#documentation": "

\n This action offboards the Organization of the caller Amazon Web Services account from the telemetry config feature.\n

", "smithy.api#http": { "method": "POST", "uri": "/StopTelemetryEvaluationForOrganization" @@ -1335,6 +2196,18 @@ "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, + "com.amazonaws.observabilityadmin#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.observabilityadmin#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.observabilityadmin#TagMapInput": { "type": "map", "key": { @@ -1345,7 +2218,7 @@ }, "traits": { "smithy.api#length": { - "min": 0, + "min": 1, "max": 50 } } @@ -1359,6 +2232,64 @@ "target": "smithy.api#String" } }, + "com.amazonaws.observabilityadmin#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#TagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.observabilityadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.observabilityadmin#InternalServerException" + }, + { + "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, + { + "target": "com.amazonaws.observabilityadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Adds or updates tags for a telemetry rule resource.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/TagResource" + } + } + }, + "com.amazonaws.observabilityadmin#TagResourceInput": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the telemetry rule resource to tag.\n

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.observabilityadmin#TagMapInput", + "traits": { + "smithy.api#documentation": "

\n The key-value pairs to add or update for the telemetry rule resource.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.observabilityadmin#TagValue": { "type": "string", "traits": { @@ -1388,7 +2319,7 @@ "ResourceType": { "target": "com.amazonaws.observabilityadmin#ResourceType", "traits": { - "smithy.api#documentation": "

\n The type of resource, for example AWS::EC2::Instance.\n

" + "smithy.api#documentation": "

\n The type of resource, for example Amazon Web Services::EC2::Instance.\n

" } }, "ResourceIdentifier": { @@ -1429,6 +2360,127 @@ "target": "com.amazonaws.observabilityadmin#TelemetryConfiguration" } }, + "com.amazonaws.observabilityadmin#TelemetryDestinationConfiguration": { + "type": "structure", + "members": { + "DestinationType": { + "target": "com.amazonaws.observabilityadmin#DestinationType", + "traits": { + "smithy.api#documentation": "

\n The type of destination for the telemetry data (e.g., \"Amazon CloudWatch Logs\", \"S3\").\n

" + } + }, + "DestinationPattern": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The pattern used to generate the destination path or name, supporting macros like <resourceId> and <accountId>.\n

" + } + }, + "RetentionInDays": { + "target": "com.amazonaws.observabilityadmin#RetentionPeriodInDays", + "traits": { + "smithy.api#documentation": "

\n The number of days to retain the telemetry data in the destination.\n

" + } + }, + "VPCFlowLogParameters": { + "target": "com.amazonaws.observabilityadmin#VPCFlowLogParameters", + "traits": { + "smithy.api#documentation": "

\n Configuration parameters specific to VPC Flow Logs when VPC is the resource type.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Configuration specifying where and how telemetry data should be delivered for Amazon Web Services resources.\n

" + } + }, + "com.amazonaws.observabilityadmin#TelemetryRule": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.observabilityadmin#ResourceType", + "traits": { + "smithy.api#documentation": "

\n The type of Amazon Web Services resource to configure telemetry for (e.g., \"AWS::EC2::VPC\").\n

" + } + }, + "TelemetryType": { + "target": "com.amazonaws.observabilityadmin#TelemetryType", + "traits": { + "smithy.api#documentation": "

\n The type of telemetry to collect (Logs, Metrics, or Traces).\n

", + "smithy.api#required": {} + } + }, + "DestinationConfiguration": { + "target": "com.amazonaws.observabilityadmin#TelemetryDestinationConfiguration", + "traits": { + "smithy.api#documentation": "

\n Configuration specifying where and how the telemetry data should be delivered.\n

" + } + }, + "Scope": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The organizational scope to which the rule applies, specified using accounts or organizational units.\n

" + } + }, + "SelectionCriteria": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n Criteria for selecting which resources the rule applies to, such as resource tags.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Defines how telemetry should be configured for specific Amazon Web Services resources.\n

" + } + }, + "com.amazonaws.observabilityadmin#TelemetryRuleSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.observabilityadmin#TelemetryRuleSummary" + } + }, + "com.amazonaws.observabilityadmin#TelemetryRuleSummary": { + "type": "structure", + "members": { + "RuleName": { + "target": "com.amazonaws.observabilityadmin#RuleName", + "traits": { + "smithy.api#documentation": "

\n The name of the telemetry rule.\n

" + } + }, + "RuleArn": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the telemetry rule.\n

" + } + }, + "CreatedTimeStamp": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the telemetry rule was created.\n

" + } + }, + "LastUpdateTimeStamp": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

\n The timestamp when the telemetry rule was last modified.\n

" + } + }, + "ResourceType": { + "target": "com.amazonaws.observabilityadmin#ResourceType", + "traits": { + "smithy.api#documentation": "

\n The type of Amazon Web Services resource the rule applies to.\n

" + } + }, + "TelemetryType": { + "target": "com.amazonaws.observabilityadmin#TelemetryType", + "traits": { + "smithy.api#documentation": "

\n The type of telemetry (Logs, Metrics, or Traces) the rule configures.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A summary of a telemetry rule's key properties.\n

" + } + }, "com.amazonaws.observabilityadmin#TelemetryState": { "type": "enum", "members": { @@ -1475,6 +2527,244 @@ } } }, + "com.amazonaws.observabilityadmin#TooManyRequestsException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

\n The request throughput limit was exceeded.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.observabilityadmin#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#UntagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.observabilityadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.observabilityadmin#InternalServerException" + }, + { + "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, + { + "target": "com.amazonaws.observabilityadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Removes tags from a telemetry rule resource.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/UntagResource" + } + } + }, + "com.amazonaws.observabilityadmin#UntagResourceInput": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the telemetry rule resource to remove tags from.\n

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.observabilityadmin#TagKeyList", + "traits": { + "smithy.api#documentation": "

\n The list of tag keys to remove from the telemetry rule resource.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#UpdateTelemetryRule": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#UpdateTelemetryRuleInput" + }, + "output": { + "target": "com.amazonaws.observabilityadmin#UpdateTelemetryRuleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.observabilityadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.observabilityadmin#InternalServerException" + }, + { + "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, + { + "target": "com.amazonaws.observabilityadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Updates an existing telemetry rule in your account.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateTelemetryRule" + } + } + }, + "com.amazonaws.observabilityadmin#UpdateTelemetryRuleForOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.observabilityadmin#UpdateTelemetryRuleForOrganizationInput" + }, + "output": { + "target": "com.amazonaws.observabilityadmin#UpdateTelemetryRuleForOrganizationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.observabilityadmin#AccessDeniedException" + }, + { + "target": "com.amazonaws.observabilityadmin#InternalServerException" + }, + { + "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" + }, + { + "target": "com.amazonaws.observabilityadmin#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Updates an existing telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateTelemetryRuleForOrganization" + } + } + }, + "com.amazonaws.observabilityadmin#UpdateTelemetryRuleForOrganizationInput": { + "type": "structure", + "members": { + "RuleIdentifier": { + "target": "com.amazonaws.observabilityadmin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "

\n The identifier (name or ARN) of the organization telemetry rule to update.\n

", + "smithy.api#required": {} + } + }, + "Rule": { + "target": "com.amazonaws.observabilityadmin#TelemetryRule", + "traits": { + "smithy.api#documentation": "

\n The new configuration details for the organization telemetry rule, including resource type, telemetry type, and destination configuration.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#UpdateTelemetryRuleForOrganizationOutput": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the updated organization telemetry rule.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.observabilityadmin#UpdateTelemetryRuleInput": { + "type": "structure", + "members": { + "RuleIdentifier": { + "target": "com.amazonaws.observabilityadmin#RuleIdentifier", + "traits": { + "smithy.api#documentation": "

\n The identifier (name or ARN) of the telemetry rule to update.\n

", + "smithy.api#required": {} + } + }, + "Rule": { + "target": "com.amazonaws.observabilityadmin#TelemetryRule", + "traits": { + "smithy.api#documentation": "

\n The new configuration details for the telemetry rule.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.observabilityadmin#UpdateTelemetryRuleOutput": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.observabilityadmin#ResourceArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the updated telemetry rule.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.observabilityadmin#VPCFlowLogParameters": { + "type": "structure", + "members": { + "LogFormat": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The format in which VPC Flow Log entries should be logged.\n

" + } + }, + "TrafficType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The type of traffic to log (ACCEPT, REJECT, or ALL).\n

" + } + }, + "MaxAggregationInterval": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

\n The maximum interval in seconds between the capture of flow log records.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Configuration parameters specific to VPC Flow Logs.\n

" + } + }, "com.amazonaws.observabilityadmin#ValidationException": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/omics.json b/codegen/sdk/aws-models/omics.json index 69e9db8fbcc..9a948c1e9b7 100644 --- a/codegen/sdk/aws-models/omics.json +++ b/codegen/sdk/aws-models/omics.json @@ -1004,7 +1004,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a run.

", + "smithy.api#documentation": "

Cancels a run using its ID and returns a response with no body if the operation is successful. To confirm that the run has been cancelled, use the ListRuns API operation to check that it is no longer listed.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -1269,6 +1269,16 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.omics#ConnectionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$" + } + }, "com.amazonaws.omics#CreateAnnotationStore": { "type": "operation", "input": { @@ -1941,7 +1951,7 @@ } ], "traits": { - "smithy.api#documentation": "

You can create a run cache to save the task outputs from completed tasks in a run for a private workflow. Subsequent runs use the task outputs from the cache, rather than computing the task outputs again. You specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible (not in an archived state).

For more information, see Creating a run cache in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#documentation": "

Creates a run cache to store and reference task outputs from completed private runs. Specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible and not in an archived state. You can save intermediate task files to a run cache if they are declared as task outputs in the workflow definition file.

For more information, see Call caching and Creating a run cache in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -1958,7 +1968,7 @@ "cacheBehavior": { "target": "com.amazonaws.omics#CacheBehavior", "traits": { - "smithy.api#documentation": "

Default cache behavior for runs that use this cache. Supported values are:

CACHE_ON_FAILURE: Caches task outputs from completed tasks for runs that fail. This setting is useful if you're debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run.

CACHE_ALWAYS: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting.

If you don't specify a value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.

For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.

" + "smithy.api#documentation": "

Default cache behavior for runs that use this cache. Supported values are:

CACHE_ON_FAILURE: Caches task outputs from completed tasks for runs that fail. This setting is useful if you're debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run.

CACHE_ALWAYS: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting.

If you don't specify a value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.

For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.

" } }, "cacheS3Location": { @@ -2072,7 +2082,7 @@ } ], "traits": { - "smithy.api#documentation": "

You can optionally create a run group to limit the compute resources for the runs that you add to the group.

", + "smithy.api#documentation": "

Creates a run group to limit the compute resources for the runs that are added to the group. Returns an ARN, ID, and tags for the run group.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -2625,7 +2635,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a private workflow.Private workflows depend on a variety of resources that you create and configure before creating the workflow:

  • Input data: Input data for the workflow, stored in an S3 bucket or a Amazon Web Services HealthOmics sequence store.

  • Workflow definition files: Define your workflow in one or more workflow definition files, written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements.

  • Parameter template files: Define run parameters using a parameter template file (written in JSON).

  • ECR container images: Create one or more container images for the workflow. Store the images in a private ECR repository.

  • (Optional) Sentieon licenses: Request a Sentieon license if you plan to use Sentieon software in a private workflow.

For more information, see Creating or updating a private workflow in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#documentation": "

Creates a private workflow. Before you create a private workflow, you must create and configure these required resources:

  • Workflow definition files: Define your workflow in one or more workflow definition files, written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in .zip format.

  • (Optional) Parameter template: You can create a parameter template file that defines the run parameters, or Amazon Web Services HealthOmics can generate the parameter template for you.

  • ECR container images: Create one or more container images for the workflow. Store the images in a private ECR repository.

  • (Optional) Sentieon licenses: Request a Sentieon license if using the Sentieon software in a private workflow.

For more information, see Creating or updating a private workflow in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -2642,7 +2652,7 @@ "name": { "target": "com.amazonaws.omics#WorkflowName", "traits": { - "smithy.api#documentation": "

A name for the workflow.

" + "smithy.api#documentation": "

Name (optional but highly recommended) for the workflow to locate relevant information in the CloudWatch logs and Amazon Web Services HealthOmics console.

" } }, "description": { @@ -2654,38 +2664,38 @@ "engine": { "target": "com.amazonaws.omics#WorkflowEngine", "traits": { - "smithy.api#documentation": "

The workflow engine for the workflow.

" + "smithy.api#documentation": "

The workflow engine for the workflow. This is only required if you have workflow definition files from more than one engine in your zip file. Otherwise, the service can detect the engine automatically from your workflow definition.

" } }, "definitionZip": { "target": "smithy.api#Blob", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

A ZIP archive for the workflow.

" + "smithy.api#documentation": "

A ZIP archive containing the main workflow definition file and dependencies that it imports for the workflow. You can use a file with a ://fileb prefix instead of the Base64 string. For more information, see Workflow definition requirements in the Amazon Web Services HealthOmics User Guide.

" } }, "definitionUri": { "target": "com.amazonaws.omics#WorkflowDefinition", "traits": { - "smithy.api#documentation": "

The URI of a definition for the workflow.

" + "smithy.api#documentation": "

The S3 URI of a definition for the workflow. The S3 bucket must be in the same region as the workflow.

" } }, "main": { "target": "com.amazonaws.omics#WorkflowMain", "traits": { - "smithy.api#documentation": "

The path of the main definition file for the workflow.

" + "smithy.api#documentation": "

The path of the main definition file for the workflow. This parameter is not required if the ZIP archive contains only one workflow definition file, or if the main definition file is named “main”. An example path is: workflow-definition/main-file.wdl.

" } }, "parameterTemplate": { "target": "com.amazonaws.omics#WorkflowParameterTemplate", "traits": { - "smithy.api#documentation": "

A parameter template for the workflow.

" + "smithy.api#documentation": "

A parameter template for the workflow. If this field is blank, Amazon Web Services HealthOmics will automatically parse the parameter template values from your workflow definition file. To override these service generated default values, provide a parameter template. To view an example of a parameter template, see Parameter template files in the Amazon Web Services HealthOmics User Guide.

" } }, "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

", + "smithy.api#documentation": "

The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version. The storageCapacity can be overwritten at run time. The storage capacity is not required for runs with a DYNAMIC storage type.

", "smithy.api#range": { "min": 0, "max": 100000 @@ -2695,13 +2705,13 @@ "tags": { "target": "com.amazonaws.omics#TagMap", "traits": { - "smithy.api#documentation": "

Tags for the workflow.

" + "smithy.api#documentation": "

Tags for the workflow. You can define up to 50 tags for the workflow. For more information, see Adding a tag in the Amazon Web Services HealthOmics User Guide.

" } }, "requestId": { "target": "com.amazonaws.omics#WorkflowRequestId", "traits": { - "smithy.api#documentation": "

To ensure that requests don't run multiple times, specify a unique ID for each request.

", + "smithy.api#documentation": "

An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -2715,7 +2725,43 @@ "storageType": { "target": "com.amazonaws.omics#StorageType", "traits": { - "smithy.api#documentation": "

The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

" + "smithy.api#documentation": "

The default storage type for runs that use this workflow. The storageType can be overridden at run time. DYNAMIC storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see Run storage types in the Amazon Web Services HealthOmics User Guide.

" + } + }, + "readmeMarkdown": { + "target": "com.amazonaws.omics#ReadmeMarkdown", + "traits": { + "smithy.api#documentation": "

The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.

" + } + }, + "parameterTemplatePath": { + "target": "com.amazonaws.omics#ParameterTemplatePath", + "traits": { + "smithy.api#documentation": "

The path to the workflow parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow. If not specified, the workflow will be created without a parameter template.

" + } + }, + "readmePath": { + "target": "com.amazonaws.omics#ReadmePath", + "traits": { + "smithy.api#documentation": "

The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.

" + } + }, + "definitionRepository": { + "target": "com.amazonaws.omics#DefinitionRepository", + "traits": { + "smithy.api#documentation": "

The repository information for the workflow definition. This allows you to source your workflow definition directly from a code repository.

" + } + }, + "workflowBucketOwnerId": { + "target": "com.amazonaws.omics#WorkflowBucketOwnerId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the expected owner of the S3 bucket that contains the workflow definition. If not specified, the service skips the validation.

" + } + }, + "readmeUri": { + "target": "com.amazonaws.omics#S3UriForObject", + "traits": { + "smithy.api#documentation": "

The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. Requirements include:

  • The S3 URI must begin with s3://USER-OWNED-BUCKET/

  • The requester must have access to the S3 bucket and object.

  • The max README content length is 500 KiB.

" } } }, @@ -2796,7 +2842,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new workflow version for the workflow that you specify with the workflowId parameter.

When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.

Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

Don’t include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.

For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#documentation": "

Creates a new workflow version for the workflow that you specify with the workflowId parameter.

When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.

Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

Don’t include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.

For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -2905,6 +2951,36 @@ "traits": { "smithy.api#documentation": "

Amazon Web Services Id of the owner of the S3 bucket that contains the workflow definition. You need to specify this parameter if your account is not the bucket owner.

" } + }, + "readmeMarkdown": { + "target": "com.amazonaws.omics#ReadmeMarkdown", + "traits": { + "smithy.api#documentation": "

The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.

" + } + }, + "parameterTemplatePath": { + "target": "com.amazonaws.omics#ParameterTemplatePath", + "traits": { + "smithy.api#documentation": "

The path to the workflow version parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow version. If not specified, the workflow version will be created without a parameter template.

" + } + }, + "readmePath": { + "target": "com.amazonaws.omics#ReadmePath", + "traits": { + "smithy.api#documentation": "

The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.

" + } + }, + "definitionRepository": { + "target": "com.amazonaws.omics#DefinitionRepository", + "traits": { + "smithy.api#documentation": "

The repository information for the workflow version definition. This allows you to source your workflow version definition directly from a code repository.

" + } + }, + "readmeUri": { + "target": "com.amazonaws.omics#S3UriForObject", + "traits": { + "smithy.api#documentation": "

The S3 URI of the README file for the workflow version. This file provides documentation and usage information for the workflow version. Requirements include:

  • The S3 URI must begin with s3://USER-OWNED-BUCKET/

  • The requester must have access to the S3 bucket and object.

  • The max README content length is 500 KiB.

" + } } }, "traits": { @@ -2986,6 +3062,78 @@ ] } }, + "com.amazonaws.omics#DefinitionRepository": { + "type": "structure", + "members": { + "connectionArn": { + "target": "com.amazonaws.omics#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the connection to the source code repository.

", + "smithy.api#required": {} + } + }, + "fullRepositoryId": { + "target": "com.amazonaws.omics#FullRepositoryId", + "traits": { + "smithy.api#documentation": "

The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.

", + "smithy.api#required": {} + } + }, + "sourceReference": { + "target": "com.amazonaws.omics#SourceReference", + "traits": { + "smithy.api#documentation": "

The source reference for the repository, such as a branch name, tag, or commit ID.

" + } + }, + "excludeFilePatterns": { + "target": "com.amazonaws.omics#ExcludeFilePatternList", + "traits": { + "smithy.api#documentation": "

A list of file patterns to exclude when retrieving the workflow definition from the repository.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a source code repository that hosts the workflow definition files.

" + } + }, + "com.amazonaws.omics#DefinitionRepositoryDetails": { + "type": "structure", + "members": { + "connectionArn": { + "target": "com.amazonaws.omics#ConnectionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the connection to the source code repository.

" + } + }, + "fullRepositoryId": { + "target": "com.amazonaws.omics#FullRepositoryId", + "traits": { + "smithy.api#documentation": "

The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.

" + } + }, + "sourceReference": { + "target": "com.amazonaws.omics#SourceReference", + "traits": { + "smithy.api#documentation": "

The source reference for the repository, such as a branch name, tag, or commit ID.

" + } + }, + "providerType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The provider type of the source code repository, such as Bitbucket, GitHub, GitHubEnterpriseServer, GitLab, and GitLabSelfManaged.

" + } + }, + "providerEndpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The endpoint URL of the source code repository provider.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains detailed information about the source code repository that hosts the workflow definition files.

" + } + }, "com.amazonaws.omics#DeleteAnnotationStore": { "type": "operation", "input": { @@ -3334,7 +3482,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a workflow run.

", + "smithy.api#documentation": "

Deletes a run and returns a response with no body if the operation is successful. You can only delete a run that has reached a COMPLETED, FAILED, or CANCELLED stage. A completed run has delivered an output, or was cancelled and resulted in no output. When you delete a run, only the metadata associated with the run is deleted. The run outputs remain in Amazon S3 and logs remain in CloudWatch.

To verify that the workflow is deleted:

  • Use ListRuns to confirm the workflow no longer appears in the list.

  • Use GetRun to verify the workflow cannot be found.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -3381,7 +3529,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete a run cache. This action removes the cache metadata stored in the service account, but doesn't delete the data in Amazon S3. You can access the cache data in Amazon S3, for inspection or to troubleshoot issues. You can remove old cache data using standard S3 Delete operations.

For more information, see Deleting a run cache in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#documentation": "

Deletes a run cache and returns a response with no body if the operation is successful. This action removes the cache metadata stored in the service account, but does not delete the data in Amazon S3. You can access the cache data in Amazon S3, for inspection or to troubleshoot issues. You can remove old cache data using standard S3 Delete operations.

For more information, see Deleting a run cache in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -3444,7 +3592,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a workflow run group.

", + "smithy.api#documentation": "

Deletes a run group and returns a response with no body if the operation is successful.

To verify that the run group is deleted:

  • Use ListRunGroups to confirm the workflow no longer appears in the list.

  • Use GetRunGroup to verify the workflow cannot be found.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -3817,7 +3965,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a workflow.

", + "smithy.api#documentation": "

Deletes a workflow by specifying its ID. No response is returned if the deletion is successful.

To verify that the workflow is deleted:

  • Use ListWorkflows to confirm the workflow no longer appears in the list.

  • Use GetWorkflow to verify the workflow cannot be found.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -3880,7 +4028,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version.

For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#documentation": "

Deletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version.

For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -4062,6 +4210,19 @@ "smithy.api#default": false } }, + "com.amazonaws.omics#ExcludeFilePatternList": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.omics#ExportJobId": { "type": "string", "traits": { @@ -4377,6 +4538,12 @@ ] } }, + "com.amazonaws.omics#FullRepositoryId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^.+/.+$" + } + }, "com.amazonaws.omics#GeneratedFrom": { "type": "string", "traits": { @@ -6609,7 +6776,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a workflow run.

If a workflow is shared with you, you cannot export information about the run.

Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. If GetRun doesn't return the requested run, you can find run logs for all runs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#documentation": "

Gets detailed information about a specific run using its ID.

Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If GetRun does not return the requested run, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -6782,7 +6949,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieve the details for the specified run cache.

For more information, see Call caching for Amazon Web Services HealthOmics runs in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#documentation": "

Retrieves detailed information about the specified run cache using its ID.

For more information, see Call caching for Amazon Web Services HealthOmics runs in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -6913,7 +7080,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a workflow run group.

", + "smithy.api#documentation": "

Gets information about a run group and returns its metadata.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -7309,7 +7476,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a workflow run task.

", + "smithy.api#documentation": "

Gets detailed information about a run task using its ID.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -8369,7 +8536,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a workflow.

If a workflow is shared with you, you cannot export the workflow.

", + "smithy.api#documentation": "

Gets all information about a workflow using its ID.

If a workflow is shared with you, you cannot export the workflow.

For more information about your workflow status, see Verify the workflow status in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -8590,6 +8757,25 @@ "traits": { "smithy.api#documentation": "

The universally unique identifier (UUID) value for this workflow.

" } + }, + "readme": { + "target": "com.amazonaws.omics#ReadmeS3PresignedUrl", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The README content for the workflow, providing documentation and usage information.

" + } + }, + "definitionRepositoryDetails": { + "target": "com.amazonaws.omics#DefinitionRepositoryDetails", + "traits": { + "smithy.api#documentation": "

Details about the source code repository that hosts the workflow definition files.

" + } + }, + "readmePath": { + "target": "com.amazonaws.omics#ReadmePath", + "traits": { + "smithy.api#documentation": "

The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.

" + } } }, "traits": { @@ -8631,7 +8817,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#documentation": "

Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -8867,6 +9053,25 @@ "traits": { "smithy.api#documentation": "

Amazon Web Services Id of the owner of the bucket.

" } + }, + "readme": { + "target": "com.amazonaws.omics#ReadmeS3PresignedUrl", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The README content for the workflow version, providing documentation and usage information specific to this version.

" + } + }, + "definitionRepositoryDetails": { + "target": "com.amazonaws.omics#DefinitionRepositoryDetails", + "traits": { + "smithy.api#documentation": "

Details about the source code repository that hosts the workflow version definition files.

" + } + }, + "readmePath": { + "target": "com.amazonaws.omics#ReadmePath", + "traits": { + "smithy.api#documentation": "

The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.

" + } } }, "traits": { @@ -10679,7 +10884,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of your run caches.

", + "smithy.api#documentation": "

Retrieves a list of your run caches and the metadata for each cache.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -10778,7 +10983,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of run groups.

", + "smithy.api#documentation": "

Retrieves a list of all run groups and returns the metadata for each run group.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -10884,7 +11089,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of tasks for a run.

", + "smithy.api#documentation": "

Returns a list of tasks and status information within their specified run. Use this operation to monitor runs and to identify which specific tasks have failed.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -10998,7 +11203,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of runs.

Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. If the ListRuns response doesn't include specific runs that you expected, you can find run logs for all runs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#documentation": "

Retrieves a list of runs and returns each run's metadata and status.

Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If the ListRuns response doesn't include specific runs that you expected, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -11666,7 +11871,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the workflow versions for the specified workflow. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#documentation": "

Lists the workflow versions for the specified workflow. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -11788,7 +11993,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of workflows.

", + "smithy.api#documentation": "

Retrieves a list of existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify PRIVATE to retrieve a list of private workflows or specify READY2RUN for a list of all Ready2Run workflows. If you do not specify the type of workflow, this operation returns a list of existing workflows.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -12089,7 +12294,7 @@ "FederatedUser" ], "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

This is the AWS HealthOmics API Reference. For an introduction to the service, see What is AWS HealthOmics? in the AWS HealthOmics User Guide.

", + "smithy.api#documentation": "

Amazon Web Services HealthOmics is a service that helps users such as bioinformaticians, researchers, and scientists to store, query, analyze, and generate insights from genomics and other biological data. It simplifies and accelerates the process of storing and analyzing genomic information for Amazon Web Services.

For an introduction to the service, see What is Amazon Web Services HealthOmics? in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#title": "Amazon Omics", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -12757,6 +12962,16 @@ } } }, + "com.amazonaws.omics#ParameterTemplatePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + } + }, "com.amazonaws.omics#PropagatedSetLevelTags": { "type": "list", "member": { @@ -13664,6 +13879,32 @@ "smithy.api#documentation": "

The metadata of a single part of a file that was added to a multipart upload. A list of these parts is returned in the response to the ListReadSetUploadParts API.

" } }, + "com.amazonaws.omics#ReadmeMarkdown": { + "type": "string", + "traits": { + "smithy.api#mediaType": "text/markdown" + } + }, + "com.amazonaws.omics#ReadmePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + } + }, + "com.amazonaws.omics#ReadmeS3PresignedUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+$" + } + }, "com.amazonaws.omics#ReferenceArn": { "type": "string", "traits": { @@ -15061,6 +15302,12 @@ "smithy.api#pattern": "^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])(/(.{0,1024}))?$" } }, + "com.amazonaws.omics#S3UriForObject": { + "type": "string", + "traits": { + "smithy.api#pattern": "^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/((.{1,1024}))$" + } + }, "com.amazonaws.omics#SampleId": { "type": "string", "traits": { @@ -15703,6 +15950,50 @@ "smithy.api#documentation": "

Source files for a sequence.

" } }, + "com.amazonaws.omics#SourceReference": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.omics#SourceReferenceType", + "traits": { + "smithy.api#documentation": "

The type of source reference, such as branch, tag, or commit.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.omics#SourceReferenceValue", + "traits": { + "smithy.api#documentation": "

The value of the source reference, such as the branch name, tag name, or commit ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the source reference in a code repository, such as a branch, tag, or commit.

" + } + }, + "com.amazonaws.omics#SourceReferenceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "BRANCH", + "value": "BRANCH" + }, + { + "name": "TAG", + "value": "TAG" + }, + { + "name": "COMMIT", + "value": "COMMIT" + } + ] + } + }, + "com.amazonaws.omics#SourceReferenceValue": { + "type": "string" + }, "com.amazonaws.omics#SseConfig": { "type": "structure", "members": { @@ -16507,7 +16798,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a new run or duplicates an existing run.

For a new run, specify a unique requestId, the workflowId, and a role ARN. If you're using static run storage (the default), specify the required storageCapacity.

You duplicate a run by specifing a unique requestId, the runID of the run to duplicate, and a role ARN.

For more information about the optional parameters in the StartRun request, see Starting a run in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#documentation": "

Starts a new run and returns details about the run, or duplicates an existing run. A run is a single invocation of a workflow. If you provide request IDs, Amazon Web Services HealthOmics identifies duplicate requests and starts the run only once. Monitor the progress of the run by calling the GetRun API operation.

To start a new run, the following inputs are required:

  • A service role ARN (roleArn).

  • The run's workflow ID (workflowId, not the uuid or runId).

  • An Amazon S3 location (outputUri) where the run outputs will be saved.

  • All required workflow parameters (parameter), which can include optional parameters from the parameter template. The run cannot include any parameters that are not defined in the parameter template. To see all possible parameters, use the GetRun API operation.

  • For runs with a STATIC (default) storage type, specify the required storage capacity (in gibibytes). A storage capacity value is not required for runs that use DYNAMIC storage.

StartRun can also duplicate an existing run using the run's default values. You can modify these default values and/or add other optional inputs. To duplicate a run, the following inputs are required:

  • A service role ARN (roleArn).

  • The ID of the run to duplicate (runId).

  • An Amazon S3 location where the run outputs will be saved (outputUri).

To learn more about the optional parameters for StartRun, see Starting a run in the Amazon Web Services HealthOmics User Guide.

Use the retentionMode input to control how long the metadata for each run is stored in CloudWatch. There are two retention modes:

  • Specify REMOVE to automatically remove the oldest runs when you reach the maximum service retention limit for runs. It is recommended that you use the REMOVE mode to initiate major run requests so that your runs do not fail when you reach the limit.

  • The retentionMode is set to the RETAIN mode by default, which allows you to manually remove runs after reaching the maximum service retention limit. Under this setting, you cannot create additional runs until you remove the excess runs.

To learn more about the retention modes, see Run retention mode in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -16524,13 +16815,13 @@ "workflowId": { "target": "com.amazonaws.omics#WorkflowId", "traits": { - "smithy.api#documentation": "

The run's workflow ID.

" + "smithy.api#documentation": "

The run's workflow ID. The workflowId is not the UUID.

" } }, "workflowType": { "target": "com.amazonaws.omics#WorkflowType", "traits": { - "smithy.api#documentation": "

The run's workflow type.

" + "smithy.api#documentation": "

The run's workflow type. The workflowType must be specified if you are running a READY2RUN workflow. If you are running a PRIVATE workflow (default), you do not need to include the workflow type.

" } }, "runId": { @@ -16542,14 +16833,14 @@ "roleArn": { "target": "com.amazonaws.omics#RunRoleArn", "traits": { - "smithy.api#documentation": "

A service role for the run.

", + "smithy.api#documentation": "

A service role for the run. The roleArn requires access to Amazon Web Services HealthOmics, S3, Cloudwatch logs, and EC2. An example roleArn is arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ. In this example, the AWS account ID is 123456789012 and the role name is omics-service-role-serviceRole-W8O1XMPL7QZ.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.omics#RunName", "traits": { - "smithy.api#documentation": "

A name for the run.

" + "smithy.api#documentation": "

A name for the run. This is recommended to view and organize runs in the Amazon Web Services HealthOmics console and CloudWatch logs.

" } }, "cacheId": { @@ -16561,19 +16852,19 @@ "cacheBehavior": { "target": "com.amazonaws.omics#CacheBehavior", "traits": { - "smithy.api#documentation": "

The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.

" + "smithy.api#documentation": "

The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.

" } }, "runGroupId": { "target": "com.amazonaws.omics#RunGroupId", "traits": { - "smithy.api#documentation": "

The run's group ID.

" + "smithy.api#documentation": "

The run's group ID. Use a run group to cap the compute resources (and number of concurrent runs) for the runs that you add to the run group.

" } }, "priority": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

A priority for the run.

", + "smithy.api#documentation": "

Use the run priority (highest: 1) to establish the order of runs in a run group when you start a run. If multiple runs share the same priority, the run that was initiated first will have the higher priority. Runs that do not belong to a run group can be assigned a priority. The priorities of these runs are ranked among other runs that are not in a run group. For more information, see Run priority in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#range": { "min": 0, "max": 100000 @@ -16583,13 +16874,13 @@ "parameters": { "target": "com.amazonaws.omics#RunParameters", "traits": { - "smithy.api#documentation": "

Parameters for the run.

" + "smithy.api#documentation": "

Parameters for the run. The run needs all required parameters and can include optional parameters. The run cannot include any parameters that are not defined in the parameter template. To retrieve parameters from the run, use the GetRun API operation.

" } }, "storageCapacity": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The static storage capacity (in gibibytes) for this run. This field is not required if the storage type is dynamic (the system ignores any value that you enter).

", + "smithy.api#documentation": "

The STATIC storage capacity (in gibibytes, GiB) for this run. The default run storage capacity is 1200 GiB. If your requested storage capacity is unavailable, the system rounds up the value to the nearest 1200 GiB multiple. If the requested storage capacity is still unavailable, the system rounds up the value to the nearest 2400 GiB multiple. This field is not required if the storage type is DYNAMIC (the system ignores any value that you enter).

", "smithy.api#range": { "min": 0, "max": 100000 @@ -16599,7 +16890,7 @@ "outputUri": { "target": "com.amazonaws.omics#RunOutputUri", "traits": { - "smithy.api#documentation": "

An output URI for the run.

" + "smithy.api#documentation": "

An output S3 URI for the run. The S3 bucket must be in the same region as the workflow. The role ARN must have permission to write to this S3 bucket.

" } }, "logLevel": { @@ -16611,13 +16902,13 @@ "tags": { "target": "com.amazonaws.omics#TagMap", "traits": { - "smithy.api#documentation": "

Tags for the run.

" + "smithy.api#documentation": "

Tags for the run. You can add up to 50 tags per run. For more information, see Adding a tag in the Amazon Web Services HealthOmics User Guide.

" } }, "requestId": { "target": "com.amazonaws.omics#RunRequestId", "traits": { - "smithy.api#documentation": "

To ensure that requests don't run multiple times, specify a unique ID for each request.

", + "smithy.api#documentation": "

An idempotency token used to dedupe retry requests so that duplicate runs are not created.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -16625,25 +16916,25 @@ "retentionMode": { "target": "com.amazonaws.omics#RunRetentionMode", "traits": { - "smithy.api#documentation": "

The retention mode for the run. The default value is RETAIN.

Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.

" + "smithy.api#documentation": "

The retention mode for the run. The default value is RETAIN.

Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.

" } }, "storageType": { "target": "com.amazonaws.omics#StorageType", "traits": { - "smithy.api#documentation": "

The storage type for the run. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

" + "smithy.api#documentation": "

The storage type for the run. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. For more information about DYNAMIC and STATIC storage, see Run storage types in the Amazon Web Services HealthOmics User Guide.

" } }, "workflowOwnerId": { "target": "com.amazonaws.omics#WorkflowOwnerId", "traits": { - "smithy.api#documentation": "

The ID of the workflow owner.

" + "smithy.api#documentation": "

The 12-digit account ID of the workflow owner that is used for running a shared workflow. The workflow owner ID can be retrieved using the GetShare API operation. If you are the workflow owner, you do not need to include this ID.

" } }, "workflowVersionName": { "target": "com.amazonaws.omics#WorkflowVersionName", "traits": { - "smithy.api#documentation": "

The name of the workflow version.

" + "smithy.api#documentation": "

The name of the workflow version. Use workflow versions to track and organize changes to the workflow. If your workflow has multiple versions, the run uses the default version unless you specify a version name. To learn more, see Workflow versioning in the Amazon Web Services HealthOmics User Guide.

" } } }, @@ -16953,7 +17244,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 128 + "max": 150 }, "smithy.api#pattern": "^arn:.+$" } @@ -17800,7 +18091,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update a run cache.

", + "smithy.api#documentation": "

Updates a run cache using its ID and returns a response with no body if the operation is successful. You can update the run cache description, name, or the default run cache behavior with CACHE_ON_FAILURE or CACHE_ALWAYS. To confirm that your run cache settings have been properly updated, use the GetRunCache API operation.

For more information, see How call caching works in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -17880,7 +18171,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a run group.

", + "smithy.api#documentation": "

Updates the settings of a run group and returns a response with no body if the operation is successful.

You can update the following settings with UpdateRunGroup:

  • Maximum number of CPUs

  • Run time (measured in minutes)

  • Number of GPUs

  • Number of concurrent runs

  • Group name

To confirm that the settings have been successfully updated, use the ListRunGroups or GetRunGroup API operations to verify that the desired changes have been made.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -18294,7 +18585,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates information about a workflow. For more information, see Update a private workflow in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#documentation": "

Updates information about a workflow.

You can update the following workflow information:

  • Name

  • Description

  • Default storage type

  • Default storage capacity (with workflow ID)

This operation returns a response with no body if the operation is successful. You can check the workflow updates by calling the GetWorkflow API operation.

For more information, see Update a private workflow in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -18343,6 +18634,12 @@ "max": 100000 } } + }, + "readmeMarkdown": { + "target": "com.amazonaws.omics#ReadmeMarkdown", + "traits": { + "smithy.api#documentation": "

The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.

" + } } }, "traits": { @@ -18384,7 +18681,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates information about the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", + "smithy.api#documentation": "

Updates information about the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

", "smithy.api#endpoint": { "hostPrefix": "workflows-" }, @@ -18436,6 +18733,12 @@ "max": 100000 } } + }, + "readmeMarkdown": { + "target": "com.amazonaws.omics#ReadmeMarkdown", + "traits": { + "smithy.api#documentation": "

The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.

" + } } }, "traits": { @@ -19070,6 +19373,10 @@ { "name": "DEFINITION", "value": "DEFINITION" + }, + { + "name": "README", + "value": "README" } ], "smithy.api#length": { @@ -19445,7 +19752,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 128 + "max": 150 }, "smithy.api#pattern": "^arn:.+$" } diff --git a/codegen/sdk/aws-models/opensearch.json b/codegen/sdk/aws-models/opensearch.json index c9dfc464dab..bca4a29825a 100644 --- a/codegen/sdk/aws-models/opensearch.json +++ b/codegen/sdk/aws-models/opensearch.json @@ -35,7 +35,7 @@ "NaturalLanguageQueryGenerationOptions": { "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsInput", "traits": { - "smithy.api#documentation": "

Container for parameters required for natural language query generation on the specified\n domain.

" + "smithy.api#documentation": "

Container for parameters required for natural language query generation on the specified domain.

" } }, "S3VectorsEngine": { @@ -55,7 +55,7 @@ "NaturalLanguageQueryGenerationOptions": { "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsOutput", "traits": { - "smithy.api#documentation": "

Container for parameters required for natural language query generation on the specified\n domain.

" + "smithy.api#documentation": "

Container for parameters required for natural language query generation on the specified domain.

" } }, "S3VectorsEngine": { @@ -66,7 +66,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for parameters representing the state of machine learning features on the\n specified domain.

" + "smithy.api#documentation": "

Container for parameters representing the state of machine learning features on the specified domain.

" } }, "com.amazonaws.opensearch#AIMLOptionsStatus": { @@ -89,7 +89,7 @@ "com.amazonaws.opensearch#ARN": { "type": "string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using\n Amazon Web Services Identity and Access Management for more information.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities\n in Using Amazon Web Services Identity and Access Management for more information.\n

", "smithy.api#length": { "min": 20, "max": 2048 @@ -358,7 +358,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new direct-query data source to the specified domain. For more information, see\n Creating Amazon\n OpenSearch Service data source integrations with Amazon S3.

", + "smithy.api#documentation": "

Creates a new direct-query data source to the specified domain. For more information, see\n Creating Amazon OpenSearch Service data source integrations with Amazon S3.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource", @@ -399,7 +399,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the parameters to the AddDataSource operation.

", + "smithy.api#documentation": "

Container for the parameters to the AddDataSource\n operation.

", "smithy.api#input": {} } }, @@ -447,7 +447,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries\n on external data.

", + "smithy.api#documentation": "

\n Adds a new data source in Amazon OpenSearch Service \n so that you can perform direct queries on external data.\n

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/directQueryDataSource", @@ -461,27 +461,27 @@ "DataSourceName": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceName", "traits": { - "smithy.api#documentation": "

A unique, user-defined label to identify the data source within your OpenSearch Service\n environment.

", + "smithy.api#documentation": "

\n A unique, user-defined label to identify the data source \n within your OpenSearch Service environment.\n

", "smithy.api#required": {} } }, "DataSourceType": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceType", "traits": { - "smithy.api#documentation": "

The supported Amazon Web Services service that you want to use as the source for direct\n queries in OpenSearch Service.

", + "smithy.api#documentation": "

\n The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service.\n

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceDescription", "traits": { - "smithy.api#documentation": "

An optional text field for providing additional context and details about the data source.\n

" + "smithy.api#documentation": "

\n An optional text field for providing additional context and details about the data source.\n

" } }, "OpenSearchArns": { "target": "com.amazonaws.opensearch#DirectQueryOpenSearchARNList", "traits": { - "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated\n with the direct query data source.

", + "smithy.api#documentation": "

\n A list of Amazon Resource Names (ARNs) for the OpenSearch \n collections that are associated with the direct query data source.\n

", "smithy.api#required": {} } }, @@ -499,7 +499,7 @@ "DataSourceArn": { "target": "com.amazonaws.opensearch#String", "traits": { - "smithy.api#documentation": "

The unique, system-generated identifier that represents the data source.

" + "smithy.api#documentation": "

\n The unique, system-generated identifier that represents the data source.\n

" } } }, @@ -618,7 +618,7 @@ } }, "traits": { - "smithy.api#documentation": "

Status of the advanced options for the specified domain. The following options are\n available:

\n
    \n
  • \n

    \n \"rest.action.multi.allow_explicit_index\": \"true\" | \"false\" - Note the use of\n a string rather than a boolean. Specifies whether explicit references to indexes are allowed\n inside the body of HTTP requests. If you want to configure access policies for domain\n sub-resources, such as specific indexes and domain APIs, you must disable this property.\n Default is true.

    \n
    • \n
  • \n

    \n \"indices.fielddata.cache.size\": \"80\" - Note the use of a string rather than\n a boolean. Specifies the percentage of heap space allocated to field data. Default is\n unbounded.

    \n
    • \n
  • \n

    \n \"indices.query.bool.max_clause_count\": \"1024\" - Note the use of a string\n rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean\n query. Default is 1,024. Queries with more than the permitted number of clauses result in a\n TooManyClauses error.

    \n
    • \n
  • \n

    \n \"override_main_response_version\": \"true\" | \"false\" - Note the use of a string\n rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow\n Elasticsearch OSS clients and plugins to continue working with it. Default is false when\n creating a domain and true when upgrading a domain.

    \n
    • \n
\n

For more information, see Advanced cluster parameters.

" + "smithy.api#documentation": "

Status of the advanced options for the specified domain. The following options are\n available:

\n
    \n
  • \n

    \n \"rest.action.multi.allow_explicit_index\": \"true\" | \"false\" - Note the use of\n a string rather than a boolean. Specifies whether explicit references to indexes are allowed\n inside the body of HTTP requests. If you want to configure access policies for domain\n sub-resources, such as specific indexes and domain APIs, you must disable this property.\n Default is true.

    \n
    • \n
  • \n

    \n \"indices.fielddata.cache.size\": \"80\" - Note the use of a string rather than\n a boolean. Specifies the percentage of heap space allocated to field data. Default is\n unbounded.

    \n
    • \n
  • \n

    \n \"indices.query.bool.max_clause_count\": \"1024\" - Note the use of a string\n rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean\n query. Default is 1,024. Queries with more than the permitted number of clauses result in a\n TooManyClauses error.

    \n
    • \n
  • \n

    \n \"override_main_response_version\": \"true\" | \"false\" - Note the use of a string\n rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow\n Elasticsearch OSS clients and plugins to continue working with it. Default is false when\n creating a domain and true when upgrading a domain.

    \n
    • \n
\n

For more information, see Advanced cluster parameters.

" } }, "com.amazonaws.opensearch#AdvancedSecurityOptions": { @@ -645,7 +645,13 @@ "JWTOptions": { "target": "com.amazonaws.opensearch#JWTOptionsOutput", "traits": { - "smithy.api#documentation": "

Container for information about the JWT configuration of the Amazon OpenSearch\n Service.

" + "smithy.api#documentation": "

Container for information about the JWT configuration of the Amazon OpenSearch Service.

" + } + }, + "IAMFederationOptions": { + "target": "com.amazonaws.opensearch#IAMFederationOptionsOutput", + "traits": { + "smithy.api#documentation": "

Container for information about the IAM federation configuration for an OpenSearch UI application.

" } }, "AnonymousAuthDisableDate": { @@ -695,7 +701,13 @@ "JWTOptions": { "target": "com.amazonaws.opensearch#JWTOptionsInput", "traits": { - "smithy.api#documentation": "

Container for information about the JWT configuration of the Amazon OpenSearch Service.\n

" + "smithy.api#documentation": "

Container for information about the JWT configuration of the Amazon OpenSearch Service.

" + } + }, + "IAMFederationOptions": { + "target": "com.amazonaws.opensearch#IAMFederationOptionsInput", + "traits": { + "smithy.api#documentation": "

Container for information about the IAM federation configuration for an OpenSearch UI application.

" } }, "AnonymousAuthEnabled": { @@ -2067,7 +2079,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration settings for an OpenSearch application. For more information, see see Using the\n OpenSearch user interface in Amazon OpenSearch Service.

" + "smithy.api#documentation": "

Configuration settings for an OpenSearch application. For more information, see \n see Using the OpenSearch user interface in Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#AppConfigType": { @@ -2192,7 +2204,7 @@ "status": { "target": "com.amazonaws.opensearch#ApplicationStatus", "traits": { - "smithy.api#documentation": "

The current status of an OpenSearch application. Possible values: CREATING,\n UPDATING, DELETING, FAILED, ACTIVE, and\n DELETED.

" + "smithy.api#documentation": "

The current status of an OpenSearch application. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

" } }, "createdAt": { @@ -2241,7 +2253,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a package with an Amazon OpenSearch Service domain. For more information, see\n Custom packages for Amazon OpenSearch Service.

", + "smithy.api#documentation": "

Associates a package with an Amazon OpenSearch Service domain. For more information, see\n Custom packages\n for Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/packages/associate/{PackageID}/{DomainName}", @@ -2255,7 +2267,7 @@ "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { - "smithy.api#documentation": "

Internal ID of the package to associate with a domain. Use DescribePackages to\n find this value.

", + "smithy.api#documentation": "

Internal ID of the package to associate with a domain. Use DescribePackages to find this value.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2271,7 +2283,7 @@ "PrerequisitePackageIDList": { "target": "com.amazonaws.opensearch#PackageIDList", "traits": { - "smithy.api#documentation": "

A list of package IDs that must be associated with the domain before the package specified\n in the request can be associated.

" + "smithy.api#documentation": "

A list of package IDs that must be associated with the domain before the package specified in the request can be associated.

" } }, "AssociationConfiguration": { @@ -2330,7 +2342,7 @@ } ], "traits": { - "smithy.api#documentation": "

Operation in the Amazon OpenSearch Service API for associating multiple packages with a\n domain simultaneously.

", + "smithy.api#documentation": "

Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/packages/associateMultiple", @@ -2465,7 +2477,7 @@ "Principal": { "target": "com.amazonaws.opensearch#String", "traits": { - "smithy.api#documentation": "

The IAM principal that\n is allowed access to the domain.

" + "smithy.api#documentation": "

The IAM principal that is allowed access to the domain.

" } } }, @@ -2568,7 +2580,7 @@ } }, "traits": { - "smithy.api#documentation": "\n

This object is deprecated. Use the domain's off-peak window to\n schedule Auto-Tune optimizations. For migration instructions, see Migrating from\n Auto-Tune maintenance windows.

\n \n

The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch\n Service.

" + "smithy.api#documentation": "\n

This object is deprecated. Use the domain's off-peak window to\n schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune\n maintenance windows.

\n \n

The Auto-Tune maintenance schedule.\n For more information, see Auto-Tune for Amazon OpenSearch\n Service.

" } }, "com.amazonaws.opensearch#AutoTuneMaintenanceScheduleList": { @@ -2627,13 +2639,13 @@ "MaintenanceSchedules": { "target": "com.amazonaws.opensearch#AutoTuneMaintenanceScheduleList", "traits": { - "smithy.api#documentation": "

A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance\n windows are deprecated and have been replaced with off-peak windows.

" + "smithy.api#documentation": "

A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows.

" } }, "UseOffPeakWindow": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

Whether to schedule Auto-Tune optimizations that require blue/green deployments during the\n domain's configured daily off-peak window.

" + "smithy.api#documentation": "

Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.

" } } }, @@ -2659,7 +2671,7 @@ "UseOffPeakWindow": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a\n maintenance schedule.

" + "smithy.api#documentation": "

Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather\n than a maintenance schedule.

" } } }, @@ -2746,7 +2758,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch\n Service.

" + "smithy.api#documentation": "

The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service.\n

" } }, "com.amazonaws.opensearch#AutoTuneStatus": { @@ -2832,7 +2844,7 @@ "ZoneStatus": { "target": "com.amazonaws.opensearch#ZoneStatus", "traits": { - "smithy.api#documentation": "

The current state of the Availability Zone. Current options are Active and\n StandBy.

\n
    \n
  • \n

    \n Active - Data nodes in the Availability Zone are in use.

    \n
    • \n
  • \n

    \n StandBy - Data nodes in the Availability Zone are in a standby state.

    \n
    • \n
  • \n

    \n NotAvailable - Unable to retrieve information.

    \n
    • \n
" + "smithy.api#documentation": "

The current state of the Availability Zone. Current options are Active and StandBy.

\n
    \n
  • \n

    \n Active - Data nodes in the Availability Zone are in use.

    \n
    • \n
  • \n

    \n StandBy - Data nodes in the Availability Zone are in a standby state.

    \n
    • \n
  • \n

    \n NotAvailable - Unable to retrieve information.

    \n
    • \n
" } }, "ConfiguredDataNodeCount": { @@ -2856,7 +2868,7 @@ "TotalUnAssignedShards": { "target": "com.amazonaws.opensearch#NumberOfShards", "traits": { - "smithy.api#documentation": "

The total number of primary and replica shards that aren't allocated to any of the nodes in\n the Availability Zone.

" + "smithy.api#documentation": "

The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.

" } } }, @@ -2950,7 +2962,7 @@ "DryRun": { "target": "com.amazonaws.opensearch#DryRun", "traits": { - "smithy.api#documentation": "

When set to True, returns the list of change IDs and properties that will be\n cancelled without actually cancelling the change.

" + "smithy.api#documentation": "

When set to True, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.

" } } }, @@ -2976,7 +2988,7 @@ "DryRun": { "target": "com.amazonaws.opensearch#DryRun", "traits": { - "smithy.api#documentation": "

Whether or not the request was a dry run. If True, the changes were not\n actually cancelled.

" + "smithy.api#documentation": "

Whether or not the request was a dry run. If True, the changes were not actually cancelled.

" } } }, @@ -3058,7 +3070,7 @@ "CancelledValue": { "target": "com.amazonaws.opensearch#String", "traits": { - "smithy.api#documentation": "

The pending value of the property that was cancelled. This would have been the eventual\n value of the property if the chance had not been cancelled.

" + "smithy.api#documentation": "

The pending value of the property that was cancelled. This would have been the eventual value of the property if the chance had not been cancelled.

" } }, "ActiveValue": { @@ -3108,7 +3120,7 @@ "StartTime": { "target": "com.amazonaws.opensearch#UpdateTimestamp", "traits": { - "smithy.api#documentation": "

The time that the configuration change was initiated, in Universal Coordinated Time\n (UTC).

" + "smithy.api#documentation": "

The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

" } }, "LastUpdatedTime": { @@ -3224,7 +3236,7 @@ "ChangeProgressStages": { "target": "com.amazonaws.opensearch#ChangeProgressStageList", "traits": { - "smithy.api#documentation": "

The specific stages that the domain is going through to perform the configuration\n change.

" + "smithy.api#documentation": "

The specific stages that the domain is going through to perform the configuration change.

" } }, "LastUpdatedTime": { @@ -3265,13 +3277,13 @@ "RoleArn": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceRoleArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the IAM role that grants OpenSearch Service permission to access\n the specified data source.

", + "smithy.api#documentation": "

\n The unique identifier of the IAM role that grants \n OpenSearch Service permission to access the specified data source.\n

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Configuration details for a CloudWatch Logs data source that can be used for direct\n queries.

" + "smithy.api#documentation": "

\n Configuration details for a CloudWatch Logs data source \n that can be used for direct queries.\n

" } }, "com.amazonaws.opensearch#CloudWatchLogsLogGroupArn": { @@ -3327,7 +3339,7 @@ "DedicatedMasterCount": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { - "smithy.api#documentation": "

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not\n 4, otherwise you receive a validation exception.

" + "smithy.api#documentation": "

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4,\n otherwise you receive a validation exception.

" } }, "WarmEnabled": { @@ -3357,7 +3369,7 @@ "MultiAZWithStandbyEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more\n information, see Configuring a multi-AZ\n domain in Amazon OpenSearch Service.

" + "smithy.api#documentation": "

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

" } }, "NodeOptions": { @@ -3368,7 +3380,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the cluster configuration of an OpenSearch Service domain. For more\n information, see Creating and managing\n Amazon OpenSearch Service domains.

" + "smithy.api#documentation": "

Container for the cluster configuration of an OpenSearch Service domain. For more\n information, see Creating and managing Amazon OpenSearch Service domains.

" } }, "com.amazonaws.opensearch#ClusterConfigStatus": { @@ -3453,7 +3465,7 @@ "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage\n to enable cold storage.

", + "smithy.api#documentation": "

Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.

", "smithy.api#required": {} } } @@ -3603,7 +3615,7 @@ } }, "traits": { - "smithy.api#documentation": "

The connection mode for the cross-cluster connection.

\n
    \n
  • \n

    \n DIRECT - Used for cross-cluster search or cross-cluster\n replication.

    \n
    • \n
  • \n

    \n VPC_ENDPOINT - Used for remote reindex between Amazon\n OpenSearch Service VPC domains.

    \n
    • \n
" + "smithy.api#documentation": "

The connection mode for the cross-cluster connection.

\n
    \n
  • \n

    \n DIRECT - Used for cross-cluster search or cross-cluster replication.

    \n
    • \n
  • \n

    \n VPC_ENDPOINT - Used for remote reindex\n between Amazon OpenSearch Service VPC domains.

    \n
    • \n
" } }, "com.amazonaws.opensearch#ConnectionProperties": { @@ -3658,7 +3670,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an OpenSearch UI application. For more information, see Using the OpenSearch user\n interface in Amazon OpenSearch Service.

", + "smithy.api#documentation": "

Creates an OpenSearch UI application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/application", @@ -3692,13 +3704,13 @@ "iamIdentityCenterOptions": { "target": "com.amazonaws.opensearch#IamIdentityCenterOptionsInput", "traits": { - "smithy.api#documentation": "

Configuration settings for integrating Amazon Web Services IAM Identity Center with the\n OpenSearch application.

" + "smithy.api#documentation": "

Configuration settings for integrating Amazon Web Services IAM Identity Center with the OpenSearch application.

" } }, "appConfigs": { "target": "com.amazonaws.opensearch#AppConfigs", "traits": { - "smithy.api#documentation": "

Configuration settings for the OpenSearch application, including administrative\n options.

" + "smithy.api#documentation": "

Configuration settings for the OpenSearch application, including administrative options.

" } }, "tagList": { @@ -3742,7 +3754,7 @@ "appConfigs": { "target": "com.amazonaws.opensearch#AppConfigs", "traits": { - "smithy.api#documentation": "

Configuration settings for the OpenSearch application, including administrative\n options.

" + "smithy.api#documentation": "

Configuration settings for the OpenSearch application, including administrative options.

" } }, "tagList": { @@ -3836,7 +3848,7 @@ "IPAddressType": { "target": "com.amazonaws.opensearch#IPAddressType", "traits": { - "smithy.api#documentation": "

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share\n domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set\n your IP address type to dual stack, you can't change your address type later.

" + "smithy.api#documentation": "

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share\n domain resources across IPv4 and IPv6 address types, and is the recommended option. \n If you set your IP address type to dual stack, you can't change your address type later.

" } }, "SnapshotOptions": { @@ -3896,7 +3908,7 @@ "IdentityCenterOptions": { "target": "com.amazonaws.opensearch#IdentityCenterOptionsInput", "traits": { - "smithy.api#documentation": "

Configuration options for enabling and managing IAM Identity Center integration within a\n domain.

" + "smithy.api#documentation": "

Configuration options for enabling and managing IAM Identity Center integration within a domain.

" } }, "TagList": { @@ -4152,13 +4164,13 @@ "EngineVersion": { "target": "com.amazonaws.opensearch#EngineVersion", "traits": { - "smithy.api#documentation": "

The version of the Amazon OpenSearch Service engine for which is compatible with the\n package. This can only be specified for package type ZIP-PLUGIN\n

" + "smithy.api#documentation": "

The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type ZIP-PLUGIN\n

" } }, "PackageVendingOptions": { "target": "com.amazonaws.opensearch#PackageVendingOptions", "traits": { - "smithy.api#documentation": "

The vending options for the package being created. They determine if the package can be\n vended to other users.

" + "smithy.api#documentation": "

The vending options for the package being created. They determine if the package can be vended to other users.

" } }, "PackageEncryptionOptions": { @@ -4489,7 +4501,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a direct-query data source. For more information, see Deleting an Amazon\n OpenSearch Service data source with Amazon S3.

", + "smithy.api#documentation": "

Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}", @@ -4518,7 +4530,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the parameters to the DeleteDataSource operation.

", + "smithy.api#documentation": "

Container for the parameters to the DeleteDataSource\n operation.

", "smithy.api#input": {} } }, @@ -4563,7 +4575,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a previously configured direct query data source from Amazon OpenSearch Service.\n

", + "smithy.api#documentation": "

\n Deletes a previously configured direct query data \n source from Amazon OpenSearch Service.\n

", "smithy.api#http": { "method": "DELETE", "uri": "/2021-01-01/opensearch/directQueryDataSource/{DataSourceName}", @@ -4577,7 +4589,7 @@ "DataSourceName": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceName", "traits": { - "smithy.api#documentation": "

A unique, user-defined label to identify the data source within your OpenSearch Service\n environment.

", + "smithy.api#documentation": "

\n A unique, user-defined label to identify the data source \n within your OpenSearch Service environment.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4646,7 +4658,7 @@ } }, "traits": { - "smithy.api#documentation": "

The results of a DeleteDomain request. Contains the status of the pending\n deletion, or a \"domain not found\" error if the domain and all of its resources have been\n deleted.

", + "smithy.api#documentation": "

The results of a DeleteDomain request. Contains the status of the pending\n deletion, or a \"domain not found\" error if the domain and all of its resources have been deleted.

", "smithy.api#output": {} } }, @@ -4807,7 +4819,7 @@ "PackageID": { "target": "com.amazonaws.opensearch#PackageID", "traits": { - "smithy.api#documentation": "

The internal ID of the package you want to delete. Use DescribePackages to find\n this value.

", + "smithy.api#documentation": "

The internal ID of the package you want to delete. Use DescribePackages to find this value.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5067,7 +5079,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } } }, @@ -5099,7 +5111,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about the current blue/green deployment happening on an Amazon\n OpenSearch Service domain. For more information, see Making\n configuration changes in Amazon OpenSearch Service.

", + "smithy.api#documentation": "

Returns information about the current blue/green deployment happening on an Amazon\n OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/progress", @@ -5137,7 +5149,7 @@ "ChangeProgressStatus": { "target": "com.amazonaws.opensearch#ChangeProgressStatusDetails", "traits": { - "smithy.api#documentation": "

Container for information about the stages of a configuration change happening on a\n domain.

" + "smithy.api#documentation": "

Container for information about the stages of a configuration change happening on a domain.

" } } }, @@ -5236,7 +5248,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about domain and node health, the standby Availability Zone, number of\n nodes per Availability Zone, and shard count per node.

", + "smithy.api#documentation": "

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/health", @@ -5267,31 +5279,31 @@ "DomainState": { "target": "com.amazonaws.opensearch#DomainState", "traits": { - "smithy.api#documentation": "

The current state of the domain.

\n
    \n
  • \n

    \n Processing - The domain has updates in progress.

    \n
    • \n
  • \n

    \n Active - Requested changes have been processed and deployed to the\n domain.

    \n
    • \n
" + "smithy.api#documentation": "

The current state of the domain.

\n
    \n
  • \n

    \n Processing - The domain has updates in progress.

    \n
    • \n
  • \n

    \n Active - Requested changes have been processed and deployed to the domain.

    \n
    • \n
" } }, "AvailabilityZoneCount": { "target": "com.amazonaws.opensearch#NumberOfAZs", "traits": { - "smithy.api#documentation": "

The number of Availability Zones configured for the domain. If the service is unable to\n fetch this information, it will return NotAvailable.

" + "smithy.api#documentation": "

The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

" } }, "ActiveAvailabilityZoneCount": { "target": "com.amazonaws.opensearch#NumberOfAZs", "traits": { - "smithy.api#documentation": "

The number of active Availability Zones configured for the domain. If the service is unable\n to fetch this information, it will return NotAvailable.

" + "smithy.api#documentation": "

The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

" } }, "StandByAvailabilityZoneCount": { "target": "com.amazonaws.opensearch#NumberOfAZs", "traits": { - "smithy.api#documentation": "

The number of standby Availability Zones configured for the domain. If the service is unable\n to fetch this information, it will return NotAvailable.

" + "smithy.api#documentation": "

The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

" } }, "DataNodeCount": { "target": "com.amazonaws.opensearch#NumberOfNodes", "traits": { - "smithy.api#documentation": "

The number of data nodes configured for the domain. If the service is unable to fetch this\n information, it will return NotAvailable.

" + "smithy.api#documentation": "

The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.

" } }, "DedicatedMaster": { @@ -5303,7 +5315,7 @@ "MasterEligibleNodeCount": { "target": "com.amazonaws.opensearch#NumberOfNodes", "traits": { - "smithy.api#documentation": "

The number of nodes that can be elected as a master node. If dedicated master nodes is\n turned on, this value is the number of dedicated master nodes configured for the domain. If the\n service is unable to fetch this information, it will return NotAvailable.

" + "smithy.api#documentation": "

The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain.\n If the service is unable to fetch this information, it will return NotAvailable.

" } }, "WarmNodeCount": { @@ -5315,13 +5327,13 @@ "MasterNode": { "target": "com.amazonaws.opensearch#MasterNodeStatus", "traits": { - "smithy.api#documentation": "

Indicates whether the domain has an elected master node.

\n
    \n
  • \n

    \n Available - The domain has an elected master node.

    \n
    • \n
  • \n

    \n UnAvailable - The master node hasn't yet been elected,\n and a quorum to elect a new master node hasn't been reached.

    \n
    • \n
" + "smithy.api#documentation": "

Indicates whether the domain has an elected master node.

\n
    \n
  • \n

    \n Available - The domain has an elected master node.

    \n
    • \n
  • \n

    \n UnAvailable - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached.

    \n
    • \n
" } }, "ClusterHealth": { "target": "com.amazonaws.opensearch#DomainHealth", "traits": { - "smithy.api#documentation": "

The current health status of your cluster.

\n
    \n
  • \n

    \n Red - At least one primary shard is not allocated to any node.

    \n
    • \n
  • \n

    \n Yellow - All primary shards are allocated to nodes, but some replicas\n aren’t.

    \n
    • \n
  • \n

    \n Green - All primary shards and their replicas are allocated to nodes.

    \n
    • \n
  • \n

    \n NotAvailable - Unable to retrieve cluster health.

    \n
    • \n
" + "smithy.api#documentation": "

The current health status of your cluster.

\n
    \n
  • \n

    \n Red - At least one primary shard is not allocated to any node.

    \n
    • \n
  • \n

    \n Yellow - All primary shards are allocated to nodes, but some replicas aren’t.

    \n
    • \n
  • \n

    \n Green - All primary shards and their replicas are allocated to nodes.

    \n
    • \n
  • \n

    \n NotAvailable - Unable to retrieve cluster health.

    \n
    • \n
" } }, "TotalShards": { @@ -5333,7 +5345,7 @@ "TotalUnAssignedShards": { "target": "com.amazonaws.opensearch#NumberOfShards", "traits": { - "smithy.api#documentation": "

The total number of primary and replica shards not allocated to any of the nodes for the\n cluster.

" + "smithy.api#documentation": "

The total number of primary and replica shards not allocated to any of the nodes for the cluster.

" } }, "EnvironmentInformation": { @@ -5344,7 +5356,7 @@ } }, "traits": { - "smithy.api#documentation": "

The result of a DescribeDomainHealth request. Contains health information for\n the requested domain.

", + "smithy.api#documentation": "

The result of a DescribeDomainHealth request. Contains health information for the requested domain.

", "smithy.api#output": {} } }, @@ -5398,7 +5410,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the parameters to the DescribeDomainNodes operation.

", + "smithy.api#documentation": "

Container for the parameters to the DescribeDomainNodes\n operation.

", "smithy.api#input": {} } }, @@ -5408,12 +5420,12 @@ "DomainNodesStatusList": { "target": "com.amazonaws.opensearch#DomainNodesStatusList", "traits": { - "smithy.api#documentation": "

Contains nodes information list DomainNodesStatusList with details about the\n all nodes on the requested domain.

" + "smithy.api#documentation": "

Contains nodes information list DomainNodesStatusList with\n details about the all nodes on the requested domain.

" } } }, "traits": { - "smithy.api#documentation": "

The result of a DescribeDomainNodes request. Contains information about the\n nodes on the requested domain.

", + "smithy.api#documentation": "

The result of a DescribeDomainNodes request. Contains information about the nodes on the requested domain.

", "smithy.api#output": {} } }, @@ -5536,7 +5548,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service\n domain. For more information, see Determining whether a change will cause a blue/green deployment.

", + "smithy.api#documentation": "

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch\n Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/dryRun", @@ -5654,7 +5666,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the parameters to the DescribeInboundConnections\n operation.

", + "smithy.api#documentation": "

Container for the parameters to the DescribeInboundConnections operation.

", "smithy.api#input": {} } }, @@ -5670,7 +5682,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } } }, @@ -5744,7 +5756,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the parameters to the DescribeInstanceTypeLimits\n operation.

", + "smithy.api#documentation": "

Container for the parameters to the DescribeInstanceTypeLimits operation.

", "smithy.api#input": {} } }, @@ -5754,7 +5766,7 @@ "LimitsByRole": { "target": "com.amazonaws.opensearch#LimitsByRole", "traits": { - "smithy.api#documentation": "

Map that contains all applicable instance type limits.data refers to data\n nodes.master refers to dedicated master nodes.

" + "smithy.api#documentation": "

Map that contains all applicable instance type limits.data refers to data\n nodes.master refers to dedicated master nodes.

" } } }, @@ -5817,7 +5829,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the parameters to the DescribeOutboundConnections\n operation.

", + "smithy.api#documentation": "

Container for the parameters to the DescribeOutboundConnections operation.

", "smithy.api#input": {} } }, @@ -5833,7 +5845,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } } }, @@ -5907,7 +5919,7 @@ "target": "com.amazonaws.opensearch#DescribePackagesFilter" }, "traits": { - "smithy.api#documentation": "

A list of DescribePackagesFilter to filter the packages included in a\n DescribePackages response.

" + "smithy.api#documentation": "

A list of DescribePackagesFilter to filter the packages included in a DescribePackages\n response.

" } }, "com.amazonaws.opensearch#DescribePackagesFilterName": { @@ -5981,13 +5993,13 @@ "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use\n nextToken to get the next page of results.

" + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use\n nextToken to get the next page of results.

" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

If your initial DescribePackageFilters operation returns a\n nextToken, you can include the returned nextToken in subsequent\n DescribePackageFilters operations, which returns results in the next page.

" + "smithy.api#documentation": "

If your initial DescribePackageFilters operation returns a\n nextToken, you can include the returned nextToken in subsequent\n DescribePackageFilters operations, which returns results in the next page.

" } } }, @@ -6008,7 +6020,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#String", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } } }, @@ -6040,7 +6052,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given\n Region. For more information, see Reserved Instances in Amazon OpenSearch\n Service.

", + "smithy.api#documentation": "

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given\n Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/reservedInstanceOfferings", @@ -6090,7 +6102,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } }, "ReservedInstanceOfferings": { @@ -6147,7 +6159,7 @@ "ReservedInstanceId": { "target": "com.amazonaws.opensearch#GUID", "traits": { - "smithy.api#documentation": "

The reserved instance identifier filter value. Use this parameter to show only the\n reservation that matches the specified reserved OpenSearch instance ID.

", + "smithy.api#documentation": "

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the\n specified reserved OpenSearch instance ID.

", "smithy.api#httpQuery": "reservationId" } }, @@ -6178,7 +6190,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#String", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } }, "ReservedInstances": { @@ -6270,42 +6282,42 @@ "DataSourceName": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceName", "traits": { - "smithy.api#documentation": "

A unique, user-defined label to identify the data source within your OpenSearch Service\n environment.

" + "smithy.api#documentation": "

\n A unique, user-defined label to identify the data source \n within your OpenSearch Service environment.\n

" } }, "DataSourceType": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceType", "traits": { - "smithy.api#documentation": "

The supported Amazon Web Services service that is used as the source for direct queries in\n OpenSearch Service.

" + "smithy.api#documentation": "

\n The supported Amazon Web Services service that is used as the source for direct queries in OpenSearch Service. \n

" } }, "Description": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceDescription", "traits": { - "smithy.api#documentation": "

A description that provides additional context and details about the data source.

" + "smithy.api#documentation": "

\n A description that provides additional context and details about the data source.

" } }, "OpenSearchArns": { "target": "com.amazonaws.opensearch#DirectQueryOpenSearchARNList", "traits": { - "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated\n with the direct query data source.

" + "smithy.api#documentation": "

\n A list of Amazon Resource Names (ARNs) for the OpenSearch \n collections that are associated with the direct query data source.\n

" } }, "DataSourceArn": { "target": "com.amazonaws.opensearch#String", "traits": { - "smithy.api#documentation": "

The unique, system-generated identifier that represents the data source.

" + "smithy.api#documentation": "

\n The unique, system-generated identifier that represents the data source.

" } }, "TagList": { "target": "com.amazonaws.opensearch#TagList", "traits": { - "smithy.api#documentation": "

A list of tags attached to a direct query data source.

" + "smithy.api#documentation": "

\n A list of tags attached to a direct query data source.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration details for a data source that can be directly queried.

" + "smithy.api#documentation": "

\n The configuration details for a data source that can be directly queried.\n

" } }, "com.amazonaws.opensearch#DirectQueryDataSourceDescription": { @@ -6350,18 +6362,18 @@ "CloudWatchLog": { "target": "com.amazonaws.opensearch#CloudWatchDirectQueryDataSource", "traits": { - "smithy.api#documentation": "

Specifies CloudWatch Logs as a type of data source for direct queries.

" + "smithy.api#documentation": "

\n Specifies CloudWatch Logs as a type of data source for direct queries.\n

" } }, "SecurityLake": { "target": "com.amazonaws.opensearch#SecurityLakeDirectQueryDataSource", "traits": { - "smithy.api#documentation": "

Specifies Security Lake as a type of data source for direct queries.

" + "smithy.api#documentation": "

\n Specifies Security Lake as a type of data source for direct queries.\n

" } } }, "traits": { - "smithy.api#documentation": "

The type of data source that is used for direct queries. This is a supported Amazon Web Services service, such as CloudWatch Logs or Security Lake.

" + "smithy.api#documentation": "

\n The type of data source that is used for direct queries. \n This is a supported Amazon Web Services service, such as CloudWatch Logs or Security Lake.\n

" } }, "com.amazonaws.opensearch#DirectQueryOpenSearchARNList": { @@ -6578,7 +6590,7 @@ "IPAddressType": { "target": "com.amazonaws.opensearch#IPAddressTypeStatus", "traits": { - "smithy.api#documentation": "

Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share\n domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set\n your IP address type to dual stack, you can't change your address type later.

" + "smithy.api#documentation": "

Choose either dual stack or IPv4 as your IP address type. \n Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. \n If you set your IP address type to dual stack, you can't change your address type later.

" } }, "SnapshotOptions": { @@ -6638,7 +6650,7 @@ "IdentityCenterOptions": { "target": "com.amazonaws.opensearch#IdentityCenterOptionsStatus", "traits": { - "smithy.api#documentation": "

Configuration options for enabling and managing IAM Identity Center integration within a\n domain.

" + "smithy.api#documentation": "

Configuration options for enabling and managing IAM Identity Center integration within a domain.

" } }, "AutoTuneOptions": { @@ -6978,7 +6990,7 @@ "target": "com.amazonaws.opensearch#DomainNodesStatus" }, "traits": { - "smithy.api#documentation": "

List of DomainNodesStatus with details about nodes on the requested\n domain.

" + "smithy.api#documentation": "

List of DomainNodesStatus with details about nodes on\n the requested domain.

" } }, "com.amazonaws.opensearch#DomainPackageDetails": { @@ -7029,13 +7041,13 @@ "PrerequisitePackageIDList": { "target": "com.amazonaws.opensearch#PackageIDList", "traits": { - "smithy.api#documentation": "

A list of package IDs that must be associated with the domain before or with the package can\n be associated.

" + "smithy.api#documentation": "

A list of package IDs that must be associated with the domain before or with the package can be associated.

" } }, "ReferencePath": { "target": "com.amazonaws.opensearch#ReferencePath", "traits": { - "smithy.api#documentation": "

The relative path of the package on the OpenSearch Service cluster nodes. This is\n synonym_path when the package is for synonym files.

" + "smithy.api#documentation": "

The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path\n when the package is for synonym files.

" } }, "ErrorDetails": { @@ -7211,13 +7223,13 @@ "EndpointV2": { "target": "com.amazonaws.opensearch#ServiceUrl", "traits": { - "smithy.api#documentation": "

If IPAddressType to set to dualstack, a version 2 domain endpoint\n is provisioned. This endpoint functions like a normal endpoint, except that it works with both\n IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

" + "smithy.api#documentation": "

If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned.\n This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses.\n Normal endpoints work only with IPv4 IP addresses.\n

" } }, "Endpoints": { "target": "com.amazonaws.opensearch#EndpointsMap", "traits": { - "smithy.api#documentation": "

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For\n example:

\n
    \n
  • \n

    \n IPv4 IP addresses -\n 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'\n

    \n
    • \n
  • \n

    \n Dual stack IP addresses -\n 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'\n

    \n
    • \n
" + "smithy.api#documentation": "

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:

\n
    \n
  • \n

    \n IPv4 IP addresses -\n 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'\n

    \n
    • \n
  • \n

    \n Dual stack IP addresses -\n 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'\n

    \n
    • \n
" } }, "DomainEndpointV2HostedZoneId": { @@ -7332,7 +7344,7 @@ "IdentityCenterOptions": { "target": "com.amazonaws.opensearch#IdentityCenterOptions", "traits": { - "smithy.api#documentation": "

Configuration options for controlling IAM Identity Center integration within a\n domain.

" + "smithy.api#documentation": "

Configuration options for controlling IAM Identity Center integration within a domain.

" } }, "AutoTuneOptions": { @@ -7583,7 +7595,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies whether the domain should encrypt data at rest, and if so, the Key Management\n Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at\n rest for the first time on an existing domain. You can't modify this parameter after it's already\n been specified.

" + "smithy.api#documentation": "

Specifies whether the domain should encrypt data at rest, and if so, the Key Management\n Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at rest\n for the first time on an existing domain. You can't modify this parameter after it's already been\n specified.

" } }, "com.amazonaws.opensearch#EncryptionAtRestOptionsStatus": { @@ -7814,7 +7826,7 @@ "status": { "target": "com.amazonaws.opensearch#ApplicationStatus", "traits": { - "smithy.api#documentation": "

The current status of the OpenSearch application. Possible values: CREATING,\n UPDATING, DELETING, FAILED, ACTIVE, and\n DELETED.

" + "smithy.api#documentation": "

The current status of the OpenSearch application. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

" } }, "iamIdentityCenterOptions": { @@ -7913,7 +7925,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the response returned by the GetCompatibleVersions\n operation.

", + "smithy.api#documentation": "

Container for the response returned by the GetCompatibleVersions operation.

", "smithy.api#output": {} } }, @@ -7975,7 +7987,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the parameters to the GetDataSource operation.

", + "smithy.api#documentation": "

Container for the parameters to the GetDataSource\n operation.

", "smithy.api#input": {} } }, @@ -8038,7 +8050,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns detailed configuration information for a specific direct query data source in\n Amazon OpenSearch Service.

", + "smithy.api#documentation": "

\n Returns detailed configuration information for \n a specific direct query data source in Amazon OpenSearch Service.\n

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/directQueryDataSource/{DataSourceName}", @@ -8052,7 +8064,7 @@ "DataSourceName": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceName", "traits": { - "smithy.api#documentation": "

A unique, user-defined label that identifies the data source within your OpenSearch Service\n environment.

", + "smithy.api#documentation": "

\n A unique, user-defined label that identifies the data source within \n your OpenSearch Service environment.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8068,31 +8080,31 @@ "DataSourceName": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceName", "traits": { - "smithy.api#documentation": "

A unique, user-defined label to identify the data source within your OpenSearch Service\n environment.

" + "smithy.api#documentation": "

\n A unique, user-defined label to identify the data source \n within your OpenSearch Service environment.\n

" } }, "DataSourceType": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceType", "traits": { - "smithy.api#documentation": "

The supported Amazon Web Services service that is used as the source for direct queries in\n OpenSearch Service.

" + "smithy.api#documentation": "

\n The supported Amazon Web Services service that is used as the source for \n direct queries in OpenSearch Service. \n

" } }, "Description": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceDescription", "traits": { - "smithy.api#documentation": "

A description that provides additional context and details about the data source.

" + "smithy.api#documentation": "

\n A description that provides additional context and details about the data source.\n

" } }, "OpenSearchArns": { "target": "com.amazonaws.opensearch#DirectQueryOpenSearchARNList", "traits": { - "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated\n with the direct query data source.

" + "smithy.api#documentation": "

\n A list of Amazon Resource Names (ARNs) for the OpenSearch \n collections that are associated with the direct query data source.\n

" } }, "DataSourceArn": { "target": "com.amazonaws.opensearch#String", "traits": { - "smithy.api#documentation": "

The unique, system-generated identifier that represents the data source.

" + "smithy.api#documentation": "

\n The unique, system-generated identifier that represents the data source.\n

" } } }, @@ -8200,7 +8212,7 @@ } }, "traits": { - "smithy.api#documentation": "

The result of a GetDomainMaintenanceStatus request that information about the\n requested action.

", + "smithy.api#documentation": "

The result of a GetDomainMaintenanceStatus request that information about the requested action.

", "smithy.api#output": {} } }, @@ -8230,7 +8242,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of Amazon OpenSearch Service package versions, along with their creation\n time, commit message, and plugin properties (if the package is a zip plugin package). For more\n information, see Custom packages for Amazon\n OpenSearch Service.

", + "smithy.api#documentation": "

Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the \n package is a zip plugin package). For more information, see Custom packages for Amazon\n OpenSearch Service.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/packages/{PackageID}/history", @@ -8271,7 +8283,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the request parameters to the GetPackageVersionHistory\n operation.

", + "smithy.api#documentation": "

Container for the request parameters to the GetPackageVersionHistory operation.

", "smithy.api#input": {} } }, @@ -8293,12 +8305,12 @@ "NextToken": { "target": "com.amazonaws.opensearch#String", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } } }, "traits": { - "smithy.api#documentation": "

Container for response returned by GetPackageVersionHistory operation.

", + "smithy.api#documentation": "

Container for response returned by GetPackageVersionHistory operation.

", "smithy.api#output": {} } }, @@ -8385,7 +8397,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#String", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } } }, @@ -8475,6 +8487,78 @@ "com.amazonaws.opensearch#HostedZoneId": { "type": "string" }, + "com.amazonaws.opensearch#IAMFederationOptionsInput": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "

True to enable IAM federation authentication for a domain.

" + } + }, + "SubjectKey": { + "target": "com.amazonaws.opensearch#IAMFederationSubjectKey", + "traits": { + "smithy.api#documentation": "

Element of the IAM federation assertion to use for the user name. Default is\n sub.

" + } + }, + "RolesKey": { + "target": "com.amazonaws.opensearch#IAMFederationRolesKey", + "traits": { + "smithy.api#documentation": "

Element of the IAM federation assertion to use for backend roles. Default is\n roles.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The IAM federation authentication configuration for an Amazon OpenSearch Service domain.

" + } + }, + "com.amazonaws.opensearch#IAMFederationOptionsOutput": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "

True if IAM federation is enabled.

" + } + }, + "SubjectKey": { + "target": "com.amazonaws.opensearch#IAMFederationSubjectKey", + "traits": { + "smithy.api#documentation": "

The key used for matching the IAM federation subject attribute.

" + } + }, + "RolesKey": { + "target": "com.amazonaws.opensearch#IAMFederationRolesKey", + "traits": { + "smithy.api#documentation": "

The key used for matching the IAM federation roles attribute.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the IAM federation options configured for the domain.

" + } + }, + "com.amazonaws.opensearch#IAMFederationRolesKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^(null|[A-Za-z][A-Za-z0-9_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.opensearch#IAMFederationSubjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^(null|[A-Za-z][A-Za-z0-9_.:/=+\\-@]*)$" + } + }, "com.amazonaws.opensearch#IPAddressType": { "type": "enum", "members": { @@ -8528,7 +8612,7 @@ "iamRoleForIdentityCenterApplicationArn": { "target": "com.amazonaws.opensearch#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center\n application for the OpenSearch application.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch application.

" } }, "iamIdentityCenterApplicationArn": { @@ -8606,19 +8690,19 @@ "SubjectKey": { "target": "com.amazonaws.opensearch#SubjectKeyIdCOption", "traits": { - "smithy.api#documentation": "

Specifies the attribute that contains the subject identifier (such as username, user ID, or\n email) in IAM Identity Center.

" + "smithy.api#documentation": "

Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

" } }, "RolesKey": { "target": "com.amazonaws.opensearch#RolesKeyIdCOption", "traits": { - "smithy.api#documentation": "

Specifies the attribute that contains the backend role identifier (such as group name or\n group ID) in IAM Identity Center.

" + "smithy.api#documentation": "

Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

" } }, "IdentityCenterApplicationARN": { "target": "com.amazonaws.opensearch#IdentityCenterApplicationARN", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch\n Service.

" + "smithy.api#documentation": "

The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.

" } }, "IdentityStoreId": { @@ -8629,7 +8713,7 @@ } }, "traits": { - "smithy.api#documentation": "

Settings container for integrating IAM Identity Center with OpenSearch UI applications,\n which enables enabling secure user authentication and access control across multiple data\n sources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing\n centralized user management.

" + "smithy.api#documentation": "

Settings container for integrating IAM Identity Center with OpenSearch UI applications, \n which enables enabling secure user authentication and access control across multiple data sources.\n This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

" } }, "com.amazonaws.opensearch#IdentityCenterOptionsInput": { @@ -8638,25 +8722,25 @@ "EnabledAPIAccess": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch\n Service.

" + "smithy.api#documentation": "

Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch Service.

" } }, "IdentityCenterInstanceARN": { "target": "com.amazonaws.opensearch#IdentityCenterInstanceARN", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that\n uses IAM Identity Center for authentication.

" + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that uses IAM Identity Center for authentication.

" } }, "SubjectKey": { "target": "com.amazonaws.opensearch#SubjectKeyIdCOption", "traits": { - "smithy.api#documentation": "

Specifies the attribute that contains the subject identifier (such as username, user ID, or\n email) in IAM Identity Center.

" + "smithy.api#documentation": "

Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

" } }, "RolesKey": { "target": "com.amazonaws.opensearch#RolesKeyIdCOption", "traits": { - "smithy.api#documentation": "

Specifies the attribute that contains the backend role identifier (such as group name or\n group ID) in IAM Identity Center.

" + "smithy.api#documentation": "

Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

" } } }, @@ -9061,7 +9145,7 @@ } }, "traits": { - "smithy.api#documentation": "

The JWT authentication and authorization configuration for an Amazon OpenSearch Service\n domain.

" + "smithy.api#documentation": "

The JWT authentication and authorization configuration for an Amazon OpenSearch Service domain.

" } }, "com.amazonaws.opensearch#JWTOptionsOutput": { @@ -9114,7 +9198,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration parameters to enable access to the key store required by the\n package.

" + "smithy.api#documentation": "

The configuration parameters to enable access to the key store required by the package.

" } }, "com.amazonaws.opensearch#KmsKeyId": { @@ -9203,7 +9287,7 @@ "target": "com.amazonaws.opensearch#Limits" }, "traits": { - "smithy.api#documentation": "

The role of a given instance and all applicable limits. The role performed by a given\n OpenSearch instance can be one of the following:

\n
    \n
  • \n

    \n data - A data node.

    \n
    • \n
  • \n

    \n master - A dedicated master node.

    \n
    • \n
  • \n

    \n ultra_warm - An UltraWarm node.

    \n
    • \n
" + "smithy.api#documentation": "

The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can\n be one of the following:

\n
    \n
  • \n

    \n data - A data node.

    \n
    • \n
  • \n

    \n master - A dedicated master node.

    \n
    • \n
  • \n

    \n ultra_warm - An UltraWarm node.

    \n
    • \n
" } }, "com.amazonaws.opensearch#ListApplications": { @@ -9261,7 +9345,7 @@ "statuses": { "target": "com.amazonaws.opensearch#ApplicationStatuses", "traits": { - "smithy.api#documentation": "

Filters the list of OpenSearch applications by status. Possible values:\n CREATING, UPDATING, DELETING, FAILED,\n ACTIVE, and DELETED.

", + "smithy.api#documentation": "

Filters the list of OpenSearch applications by status. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

", "smithy.api#httpQuery": "statuses" } }, @@ -9283,7 +9367,7 @@ "ApplicationSummaries": { "target": "com.amazonaws.opensearch#ApplicationSummaries", "traits": { - "smithy.api#documentation": "

Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status, creation\n time, and last update time.

" + "smithy.api#documentation": "

Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status, creation time, and last update time.

" } }, "nextToken": { @@ -9323,7 +9407,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists direct-query data sources for a specific domain. For more information, see For more\n information, see Working with Amazon\n OpenSearch Service direct queries with Amazon S3.

", + "smithy.api#documentation": "

Lists direct-query data sources for a specific domain. For more information, see \n For more information, see\n Working with Amazon OpenSearch Service direct queries with Amazon S3.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource", @@ -9344,7 +9428,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the parameters to the ListDataSources operation.

", + "smithy.api#documentation": "

Container for the parameters to the ListDataSources\n operation.

", "smithy.api#input": {} } }, @@ -9389,7 +9473,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists an inventory of all the direct query data sources that you have configured within\n Amazon OpenSearch Service.

", + "smithy.api#documentation": "

\n Lists an inventory of all the direct query data sources that you\n have configured within Amazon OpenSearch Service.\n

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/directQueryDataSource", @@ -9420,7 +9504,7 @@ "DirectQueryDataSources": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceList", "traits": { - "smithy.api#documentation": "

A list of the direct query data sources that are returned by the\n ListDirectQueryDataSources API operation.

" + "smithy.api#documentation": "

\n A list of the direct query data sources that are returned by \n the ListDirectQueryDataSources API operation.\n

" } } }, @@ -9496,20 +9580,20 @@ "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use\n nextToken to get the next page of results.

", + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use\n nextToken to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

If your initial ListDomainMaintenances operation returns a\n nextToken, include the returned nextToken in subsequent\n ListDomainMaintenances operations, which returns results in the next page.

", + "smithy.api#documentation": "

If your initial ListDomainMaintenances operation returns a\n nextToken, include the returned nextToken in subsequent\n ListDomainMaintenances operations, which returns results in the next page.

", "smithy.api#httpQuery": "nextToken" } } }, "traits": { - "smithy.api#documentation": "

Container for the parameters to the ListDomainMaintenances operation.

", + "smithy.api#documentation": "

Container for the parameters to the ListDomainMaintenances\n operation.

", "smithy.api#input": {} } }, @@ -9525,12 +9609,12 @@ "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } } }, "traits": { - "smithy.api#documentation": "

The result of a ListDomainMaintenances request that contains information about\n the requested actions.

", + "smithy.api#documentation": "

The result of a ListDomainMaintenances request that contains information about the requested actions.

", "smithy.api#output": {} } }, @@ -9657,7 +9741,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the request parameters to the ListDomainsForPackage\n operation.

", + "smithy.api#documentation": "

Container for the request parameters to the ListDomainsForPackage operation.

", "smithy.api#input": {} } }, @@ -9673,12 +9757,12 @@ "NextToken": { "target": "com.amazonaws.opensearch#String", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } } }, "traits": { - "smithy.api#documentation": "

Container for the response parameters to the ListDomainsForPackage\n operation.

", + "smithy.api#documentation": "

Container for the response parameters to the ListDomainsForPackage operation.

", "smithy.api#output": {} } }, @@ -9724,7 +9808,7 @@ "EngineVersion": { "target": "com.amazonaws.opensearch#VersionString", "traits": { - "smithy.api#documentation": "

The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or\n OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

", + "smithy.api#documentation": "

The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y.\n Defaults to the latest version of OpenSearch.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9782,7 +9866,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } } }, @@ -9857,7 +9941,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the request parameters to the ListPackagesForDomain\n operation.

", + "smithy.api#documentation": "

Container for the request parameters to the ListPackagesForDomain operation.

", "smithy.api#input": {} } }, @@ -9873,12 +9957,12 @@ "NextToken": { "target": "com.amazonaws.opensearch#String", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } } }, "traits": { - "smithy.api#documentation": "

Container for the response parameters to the ListPackagesForDomain\n operation.

", + "smithy.api#documentation": "

Container for the response parameters to the ListPackagesForDomain operation.

", "smithy.api#output": {} } }, @@ -9908,7 +9992,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of configuration changes that are scheduled for a domain. These changes can\n be service software\n updates or blue/green\n Auto-Tune enhancements.

", + "smithy.api#documentation": "

Retrieves a list of configuration changes that are scheduled for a domain. These changes can\n be service software\n updates or blue/green\n Auto-Tune enhancements.

", "smithy.api#http": { "method": "GET", "uri": "/2021-01-01/opensearch/domain/{DomainName}/scheduledActions", @@ -9936,14 +10020,14 @@ "target": "com.amazonaws.opensearch#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use\n nextToken to get the next page of results.

", + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use\n nextToken to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

If your initial ListScheduledActions operation returns a\n nextToken, you can include the returned nextToken in subsequent\n ListScheduledActions operations, which returns results in the next page.

", + "smithy.api#documentation": "

If your initial ListScheduledActions operation returns a nextToken, you\n can include the returned nextToken in subsequent ListScheduledActions\n operations, which returns results in the next page.

", "smithy.api#httpQuery": "nextToken" } } @@ -9964,7 +10048,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } } }, @@ -10107,7 +10191,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } } }, @@ -10183,7 +10267,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

", + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

", "smithy.api#required": {} } } @@ -10287,7 +10371,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

", + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

", "smithy.api#required": {} } } @@ -10324,7 +10408,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

", + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

", "smithy.api#required": {} } } @@ -10350,7 +10434,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application\n and slow logs to Amazon CloudWatch. For more information, see Monitoring\n OpenSearch logs with Amazon CloudWatch Logs.

\n \n

After you enable log publishing, you still have to enable the collection of slow logs using\n the OpenSearch REST API.

\n " + "smithy.api#documentation": "

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application\n and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs.

\n \n

After you enable log publishing, you still have to enable the collection of slow logs using\n the OpenSearch REST API.

\n " } }, "com.amazonaws.opensearch#LogPublishingOptions": { @@ -10585,7 +10669,7 @@ "ValueType": { "target": "com.amazonaws.opensearch#PropertyValueType", "traits": { - "smithy.api#documentation": "

The type of value that is currently being modified. Properties can have two types:

\n
    \n
  • \n

    \n PLAIN_TEXT: Contain direct values such as \"1\", \"True\", or\n \"c5.large.search\".

    \n
    • \n
  • \n

    \n STRINGIFIED_JSON: Contain content in JSON format, such as\n {\"Enabled\":\"True\"}\".

    \n
    • \n
" + "smithy.api#documentation": "

The type of value that is currently being modified. Properties can have two types:

\n
    \n
  • \n

    \n PLAIN_TEXT: Contain direct values such as \"1\", \"True\", or \"c5.large.search\".

    \n
    • \n
  • \n

    \n STRINGIFIED_JSON: Contain content in JSON format, such as {\"Enabled\":\"True\"}\".

    \n
    • \n
" } } }, @@ -10669,12 +10753,12 @@ "DesiredState": { "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState", "traits": { - "smithy.api#documentation": "

The desired state of the natural language query generation feature. Valid values are ENABLED\n and DISABLED.

" + "smithy.api#documentation": "

The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.

" } } }, "traits": { - "smithy.api#documentation": "

Container for parameters required to enable the natural language query generation\n feature.

" + "smithy.api#documentation": "

Container for parameters required to enable the natural language query generation feature.

" } }, "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsOutput": { @@ -10683,24 +10767,24 @@ "DesiredState": { "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState", "traits": { - "smithy.api#documentation": "

The desired state of the natural language query generation feature. Valid values are ENABLED\n and DISABLED.

" + "smithy.api#documentation": "

The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.

" } }, "CurrentState": { "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationCurrentState", "traits": { - "smithy.api#documentation": "

The current state of the natural language query generation feature, indicating completion,\n in progress, or failure.

" + "smithy.api#documentation": "

The current state of the natural language query generation feature, indicating completion, in progress, or failure.

" } } }, "traits": { - "smithy.api#documentation": "

Container for parameters representing the state of the natural language query generation\n feature on the specified domain.

" + "smithy.api#documentation": "

Container for parameters representing the state of the natural language query generation feature on the specified domain.

" } }, "com.amazonaws.opensearch#NextToken": { "type": "string", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using\n the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } }, "com.amazonaws.opensearch#NodeConfig": { @@ -10809,7 +10893,7 @@ } }, "traits": { - "smithy.api#documentation": "

Enables or disables node-to-node encryption. For more information, see Node-to-node\n encryption for Amazon OpenSearch Service.

" + "smithy.api#documentation": "

Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#NodeToNodeEncryptionOptionsStatus": { @@ -10896,7 +10980,7 @@ } }, "traits": { - "smithy.api#documentation": "

A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory\n configuration changes on the domain. These actions can include scheduled service software updates\n and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the\n window that you specify.

\n

If you don't specify a window start time, it defaults to 10:00 P.M. local time.

\n

For more information, see Defining off-peak maintenance\n windows for Amazon OpenSearch Service.

" + "smithy.api#documentation": "

A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory\n configuration changes on the domain. These actions can include scheduled service software updates\n and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these\n actions during the window that you specify.

\n

If you don't specify a window start time, it defaults to 10:00 P.M. local time.

\n

For more information, see Defining off-peak maintenance\n windows for Amazon OpenSearch Service.

" } }, "com.amazonaws.opensearch#OffPeakWindowOptions": { @@ -11709,7 +11793,7 @@ "StatusCode": { "target": "com.amazonaws.opensearch#OutboundConnectionStatusCode", "traits": { - "smithy.api#documentation": "

The status code for the outbound connection. Can be one of the following:

\n
    \n
  • \n

    \n VALIDATING - The outbound connection request is being\n validated.

    \n
    • \n
  • \n

    \n VALIDATION_FAILED - Validation failed for the connection\n request.

    \n
    • \n
  • \n

    \n PENDING_ACCEPTANCE: Outbound connection request is\n validated and is not yet accepted by the remote domain owner.

    \n
    • \n
  • \n

    \n APPROVED - Outbound connection has been approved by the\n remote domain owner for getting provisioned.

    \n
    • \n
  • \n

    \n PROVISIONING - Outbound connection request is in\n process.

    \n
    • \n
  • \n

    \n ACTIVE - Outbound connection is active and ready to\n use.

    \n
    • \n
  • \n

    \n REJECTING - Outbound connection rejection by remote\n domain owner is in progress.

    \n
    • \n
  • \n

    \n REJECTED - Outbound connection request is rejected by\n remote domain owner.

    \n
    • \n
  • \n

    \n DELETING - Outbound connection deletion is in\n progress.

    \n
    • \n
  • \n

    \n DELETED - Outbound connection is deleted and can no\n longer be used.

    \n
    • \n
" + "smithy.api#documentation": "

The status code for the outbound connection. Can be one of the following:

\n
    \n
  • \n

    \n VALIDATING - The outbound connection request is being\n validated.

    \n
    • \n
  • \n

    \n VALIDATION_FAILED - Validation failed for the connection\n request.

    \n
    • \n
  • \n

    \n PENDING_ACCEPTANCE: Outbound connection request is validated and is\n not yet accepted by the remote domain owner.

    \n
    • \n
  • \n

    \n APPROVED - Outbound connection has been approved by the remote domain\n owner for getting provisioned.

    \n
    • \n
  • \n

    \n PROVISIONING - Outbound connection request is in process.

    \n
    • \n
  • \n

    \n ACTIVE - Outbound connection is active and ready to use.

    \n
    • \n
  • \n

    \n REJECTING - Outbound connection rejection by remote domain owner is in\n progress.

    \n
    • \n
  • \n

    \n REJECTED - Outbound connection request is rejected by remote domain\n owner.

    \n
    • \n
  • \n

    \n DELETING - Outbound connection deletion is in progress.

    \n
    • \n
  • \n

    \n DELETED - Outbound connection is deleted and can no longer be\n used.

    \n
    • \n
" } }, "Message": { @@ -11842,7 +11926,7 @@ "KeyStoreAccessOption": { "target": "com.amazonaws.opensearch#KeyStoreAccessOption", "traits": { - "smithy.api#documentation": "

The configuration parameters to enable accessing the key store required by the\n package.

" + "smithy.api#documentation": "

The configuration parameters to enable accessing the key store required by the package.

" } } }, @@ -11876,7 +11960,7 @@ "RequiresRestartForConfigurationUpdate": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

This indicates whether a B/G deployment is required for updating the configuration that the\n plugin is prerequisite for.

" + "smithy.api#documentation": "

This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for.

" } } }, @@ -11923,7 +12007,7 @@ "PackageStatus": { "target": "com.amazonaws.opensearch#PackageStatus", "traits": { - "smithy.api#documentation": "

The current status of the package. The available options are AVAILABLE,\n COPYING, COPY_FAILED, VALIDATNG,\n VALIDATION_FAILED, DELETING, and DELETE_FAILED.

" + "smithy.api#documentation": "

The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

" } }, "CreatedAt": { @@ -11959,7 +12043,7 @@ "AvailablePluginProperties": { "target": "com.amazonaws.opensearch#PluginProperties", "traits": { - "smithy.api#documentation": "

If the package is a ZIP-PLUGIN package, additional information about plugin\n properties.

" + "smithy.api#documentation": "

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

" } }, "AvailablePackageConfiguration": { @@ -11971,13 +12055,13 @@ "AllowListedUserList": { "target": "com.amazonaws.opensearch#PackageUserList", "traits": { - "smithy.api#documentation": "

A list of users who are allowed to view and associate the package. This field is only\n visible to the owner of a package.

" + "smithy.api#documentation": "

A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.

" } }, "PackageOwner": { "target": "com.amazonaws.opensearch#PackageOwner", "traits": { - "smithy.api#documentation": "

The owner of the package who is allowed to create and update a package and add users to the\n package scope.

" + "smithy.api#documentation": "

The owner of the package who is allowed to create and update a package and add users to the package scope.

" } }, "PackageVendingOptions": { @@ -12010,7 +12094,7 @@ "PrerequisitePackageIDList": { "target": "com.amazonaws.opensearch#PackageIDList", "traits": { - "smithy.api#documentation": "

List of package IDs that must be linked to the domain before or simultaneously with the\n package association.

" + "smithy.api#documentation": "

List of package IDs that must be linked to the domain before or simultaneously with the package association.

" } }, "AssociationConfiguration": { @@ -12235,13 +12319,13 @@ "VendingEnabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the package vending feature is enabled, allowing the package to be used by\n other users.

", + "smithy.api#documentation": "

Indicates whether the package vending feature is enabled, allowing the package to be used by other users.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Configuration options for determining whether a package can be made available for use by\n other users.

" + "smithy.api#documentation": "

Configuration options for determining whether a package can be made available for use by other users.

" } }, "com.amazonaws.opensearch#PackageVersion": { @@ -12271,7 +12355,7 @@ "PluginProperties": { "target": "com.amazonaws.opensearch#PluginProperties", "traits": { - "smithy.api#documentation": "

Additional information about plugin properties if the package is a ZIP-PLUGIN\n package.

" + "smithy.api#documentation": "

Additional information about plugin properties if the package is a ZIP-PLUGIN package.

" } }, "PackageConfiguration": { @@ -12588,7 +12672,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the request parameters to the RejectInboundConnection\n operation.

", + "smithy.api#documentation": "

Container for the request parameters to the RejectInboundConnection operation.

", "smithy.api#input": {} } }, @@ -12820,7 +12904,7 @@ "target": "com.amazonaws.opensearch#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The duration, in seconds, for which the offering will reserve the OpenSearch\n instance.

" + "smithy.api#documentation": "

The duration, in seconds, for which the offering will reserve the OpenSearch instance.

" } }, "FixedPrice": { @@ -13175,7 +13259,7 @@ "SessionTimeoutMinutes": { "target": "com.amazonaws.opensearch#IntegerClass", "traits": { - "smithy.api#documentation": "

The duration, in minutes, after which a user session becomes inactive. Acceptable values are\n between 1 and 1440, and the default value is 60.

" + "smithy.api#documentation": "

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440,\n and the default value is 60.

" } } }, @@ -13284,7 +13368,7 @@ "ScheduledBy": { "target": "com.amazonaws.opensearch#ScheduledBy", "traits": { - "smithy.api#documentation": "

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service\n automatically (SYSTEM).

" + "smithy.api#documentation": "

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically (SYSTEM).

" } }, "Status": { @@ -13423,13 +13507,13 @@ "RoleArn": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceRoleArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the IAM role that grants OpenSearch Service permission to access\n the specified data source.

", + "smithy.api#documentation": "

\n The unique identifier of the IAM role that grants OpenSearch \n Service permission to access the specified data source.\n

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Configuration details for a Security Lake data source that can be used for direct queries.\n

" + "smithy.api#documentation": "

\n Configuration details for a Security Lake data source \n that can be used for direct queries.\n

" } }, "com.amazonaws.opensearch#ServiceSoftwareOptions": { @@ -13474,7 +13558,7 @@ "AutomatedUpdateDate": { "target": "com.amazonaws.opensearch#DeploymentCloseDateTimeStamp", "traits": { - "smithy.api#documentation": "

The timestamp, in Epoch time, until which you can manually request a service software\n update. After this date, we automatically update your service software.

" + "smithy.api#documentation": "

The timestamp, in Epoch time, until which you can manually request a service software update. After this date,\n we automatically update your service software.

" } }, "OptionalDeployment": { @@ -13511,7 +13595,7 @@ } }, "traits": { - "smithy.api#documentation": "

The status of SkipUnavailable setting for the outbound connection.

\n
    \n
  • \n

    \n ENABLED - The SkipUnavailable setting is\n enabled for the connection.

    \n
    • \n
  • \n

    \n DISABLED - The SkipUnavailable setting is\n disabled for the connection.

    \n
    • \n
" + "smithy.api#documentation": "

The status of SkipUnavailable setting for the outbound connection.

\n
    \n
  • \n

    \n ENABLED - The SkipUnavailable setting is enabled\n for the connection.

    \n
    • \n
  • \n

    \n DISABLED - The SkipUnavailable setting is disabled\n for the connection.

    \n
    • \n
" } }, "com.amazonaws.opensearch#SlotList": { @@ -13604,7 +13688,7 @@ "Status": { "target": "com.amazonaws.opensearch#OptionStatus", "traits": { - "smithy.api#documentation": "

The status of service software update options, including creation date and last updated\n date.

" + "smithy.api#documentation": "

The status of service software update options, including creation date and last updated date.

" } } }, @@ -13641,7 +13725,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts the node maintenance process on the data node. These processes can include a node\n reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

", + "smithy.api#documentation": "

Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart,\n or a Dashboard or Kibana restart.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance", @@ -13675,7 +13759,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the parameters to the StartDomainMaintenance operation.

", + "smithy.api#documentation": "

Container for the parameters to the StartDomainMaintenance\n operation.

", "smithy.api#input": {} } }, @@ -13690,7 +13774,7 @@ } }, "traits": { - "smithy.api#documentation": "

The result of a StartDomainMaintenance request that information about the\n requested action.

", + "smithy.api#documentation": "

The result of a StartDomainMaintenance request that information about the requested action.

", "smithy.api#output": {} } }, @@ -13829,7 +13913,7 @@ "LimitName": { "target": "com.amazonaws.opensearch#LimitName", "traits": { - "smithy.api#documentation": "

Name of storage limits that are applicable for the given storage type. If\n StorageType is ebs, the following options are available:

\n
    \n
  • \n

    \n MinimumVolumeSize - Minimum volume size that is available\n for the given storage type. Can be empty if not applicable.

    \n
    • \n
  • \n

    \n MaximumVolumeSize - Maximum volume size that is available\n for the given storage type. Can be empty if not applicable.

    \n
    • \n
  • \n

    \n MaximumIops - Maximum amount of IOPS that is available\n for the given the storage type. Can be empty if not applicable.

    \n
    • \n
  • \n

    \n MinimumIops - Minimum amount of IOPS that is available\n for the given the storage type. Can be empty if not applicable.

    \n
    • \n
  • \n

    \n MaximumThroughput - Maximum amount of throughput that is\n available for the given the storage type. Can be empty if not applicable.

    \n
    • \n
  • \n

    \n MinimumThroughput - Minimum amount of throughput that is\n available for the given the storage type. Can be empty if not applicable.

    \n
    • \n
" + "smithy.api#documentation": "

Name of storage limits that are applicable for the given storage type. If\n StorageType is ebs, the following options are available:

\n
    \n
  • \n

    \n MinimumVolumeSize - Minimum volume size that is available for the\n given storage type. Can be empty if not applicable.

    \n
    • \n
  • \n

    \n MaximumVolumeSize - Maximum volume size that is available for the\n given storage type. Can be empty if not applicable.

    \n
    • \n
  • \n

    \n MaximumIops - Maximum amount of IOPS that is available for the given\n the storage type. Can be empty if not applicable.

    \n
    • \n
  • \n

    \n MinimumIops - Minimum amount of IOPS that is available for the given\n the storage type. Can be empty if not applicable.

    \n
    • \n
  • \n

    \n MaximumThroughput - Maximum amount of throughput that is\n available for the given the storage type. Can be empty if not applicable.

    \n
    • \n
  • \n

    \n MinimumThroughput - Minimum amount of throughput that is\n available for the given the storage type. Can be empty if not applicable.

    \n
    • \n
" } }, "LimitValues": { @@ -14163,7 +14247,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a direct-query data source. For more information, see Working with Amazon\n OpenSearch Service data source integrations with Amazon S3.

", + "smithy.api#documentation": "

Updates a direct-query data source. For more information, see\n Working with Amazon OpenSearch Service data source integrations with Amazon S3.

", "smithy.api#http": { "method": "PUT", "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}", @@ -14211,7 +14295,7 @@ } }, "traits": { - "smithy.api#documentation": "

Container for the parameters to the UpdateDataSource operation.

", + "smithy.api#documentation": "

Container for the parameters to the UpdateDataSource\n operation.

", "smithy.api#input": {} } }, @@ -14256,7 +14340,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the configuration or properties of an existing direct query data source in Amazon\n OpenSearch Service.

", + "smithy.api#documentation": "

\n Updates the configuration or properties of an existing\n direct query data source in Amazon OpenSearch Service.\n

", "smithy.api#http": { "method": "PUT", "uri": "/2021-01-01/opensearch/directQueryDataSource/{DataSourceName}", @@ -14270,7 +14354,7 @@ "DataSourceName": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceName", "traits": { - "smithy.api#documentation": "

A unique, user-defined label to identify the data source within your OpenSearch Service\n environment.

", + "smithy.api#documentation": "

\n A unique, user-defined label to identify the data \n source within your OpenSearch Service environment.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14278,20 +14362,20 @@ "DataSourceType": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceType", "traits": { - "smithy.api#documentation": "

The supported Amazon Web Services service that you want to use as the source for direct\n queries in OpenSearch Service.

", + "smithy.api#documentation": "

\n The supported Amazon Web Services service that you want to use as the source for \n direct queries in OpenSearch Service. \n

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.opensearch#DirectQueryDataSourceDescription", "traits": { - "smithy.api#documentation": "

An optional text field for providing additional context and details about the data source.\n

" + "smithy.api#documentation": "

\n An optional text field for providing additional context and \n details about the data source.\n

" } }, "OpenSearchArns": { "target": "com.amazonaws.opensearch#DirectQueryOpenSearchARNList", "traits": { - "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated\n with the direct query data source.

", + "smithy.api#documentation": "

\n A list of Amazon Resource Names (ARNs) for the OpenSearch \n collections that are associated with the direct query data source.\n

", "smithy.api#required": {} } } @@ -14306,7 +14390,7 @@ "DataSourceArn": { "target": "com.amazonaws.opensearch#String", "traits": { - "smithy.api#documentation": "

The unique, system-generated identifier that represents the data source.

" + "smithy.api#documentation": "

\n The unique, system-generated identifier that represents the data source.\n

" } } }, @@ -14343,7 +14427,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

", + "smithy.api#documentation": "

Modifies the cluster configuration of the specified Amazon OpenSearch Service\n domain.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/config", @@ -14377,7 +14461,7 @@ "SnapshotOptions": { "target": "com.amazonaws.opensearch#SnapshotOptions", "traits": { - "smithy.api#documentation": "

Option to set the time, in UTC format, for the daily automated snapshot. Default value is\n 0 hours.

" + "smithy.api#documentation": "

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.\n

" } }, "VPCOptions": { @@ -14395,7 +14479,7 @@ "AdvancedOptions": { "target": "com.amazonaws.opensearch#AdvancedOptions", "traits": { - "smithy.api#documentation": "

Key-value pairs to specify advanced configuration options. The following key-value pairs are\n supported:

\n
    \n
  • \n

    \n \"rest.action.multi.allow_explicit_index\": \"true\" | \"false\" - Note the use of\n a string rather than a boolean. Specifies whether explicit references to indexes are allowed\n inside the body of HTTP requests. If you want to configure access policies for domain\n sub-resources, such as specific indexes and domain APIs, you must disable this property.\n Default is true.

    \n
    • \n
  • \n

    \n \"indices.fielddata.cache.size\": \"80\" - Note the use of a string rather than\n a boolean. Specifies the percentage of heap space allocated to field data. Default is\n unbounded.

    \n
    • \n
  • \n

    \n \"indices.query.bool.max_clause_count\": \"1024\" - Note the use of a string\n rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean\n query. Default is 1,024. Queries with more than the permitted number of clauses result in a\n TooManyClauses error.

    \n
    • \n
\n

For more information, see Advanced cluster parameters.

" + "smithy.api#documentation": "

Key-value pairs to specify advanced configuration options. The following key-value pairs are\n supported:

\n
    \n
  • \n

    \n \"rest.action.multi.allow_explicit_index\": \"true\" | \"false\" - Note the use of\n a string rather than a boolean. Specifies whether explicit references to indexes are allowed\n inside the body of HTTP requests. If you want to configure access policies for domain\n sub-resources, such as specific indexes and domain APIs, you must disable this property.\n Default is true.

    \n
    • \n
  • \n

    \n \"indices.fielddata.cache.size\": \"80\" - Note the use of a string rather than\n a boolean. Specifies the percentage of heap space allocated to field data. Default is\n unbounded.

    \n
    • \n
  • \n

    \n \"indices.query.bool.max_clause_count\": \"1024\" - Note the use of a string\n rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean\n query. Default is 1,024. Queries with more than the permitted number of clauses result in a\n TooManyClauses error.

    \n
    • \n
\n

For more information, see Advanced cluster parameters.

" } }, "AccessPolicies": { @@ -14407,7 +14491,7 @@ "IPAddressType": { "target": "com.amazonaws.opensearch#IPAddressType", "traits": { - "smithy.api#documentation": "

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share\n domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP\n address type is currently set to dual stack, you can't change it.

" + "smithy.api#documentation": "

Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across\n IPv4 and IPv6 address types, and is the recommended option. \n If your IP address type is currently set to dual stack, you can't change it.\n

" } }, "LogPublishingOptions": { @@ -14458,7 +14542,7 @@ "DryRunMode": { "target": "com.amazonaws.opensearch#DryRunMode", "traits": { - "smithy.api#documentation": "

The type of dry run to perform.

\n
    \n
  • \n

    \n Basic only returns the type of deployment (blue/green or dynamic) that the\n update will cause.

    \n
    • \n
  • \n

    \n Verbose runs an additional check to validate the changes you're making. For\n more information, see Validating a domain update.

    \n
    • \n
" + "smithy.api#documentation": "

The type of dry run to perform.

\n
    \n
  • \n

    \n Basic only returns the type of deployment (blue/green or dynamic) that the update\n will cause.

    \n
    • \n
  • \n

    \n Verbose runs an additional check to validate the changes you're making. For\n more information, see Validating a domain update.

    \n
    • \n
" } }, "OffPeakWindowOptions": { @@ -14638,7 +14722,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the scope of a package. Scope of the package defines users who can view and\n associate a package.

", + "smithy.api#documentation": "

Updates the scope of a package. Scope of the package defines users who can view and associate a package.

", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/packages/updateScope", @@ -14733,7 +14817,7 @@ } ], "traits": { - "smithy.api#documentation": "

Reschedules a planned domain configuration change for a later time. This change can be a\n scheduled service software\n update or a blue/green\n Auto-Tune enhancement.

", + "smithy.api#documentation": "

Reschedules a planned domain configuration change for a later time. This change can be a\n scheduled service software\n update or a blue/green\n Auto-Tune enhancement.

", "smithy.api#http": { "method": "PUT", "uri": "/2021-01-01/opensearch/domain/{DomainName}/scheduledAction/update", @@ -14762,7 +14846,7 @@ "ActionType": { "target": "com.amazonaws.opensearch#ActionType", "traits": { - "smithy.api#documentation": "

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE,\n JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value,\n send a ListScheduledActions request.

", + "smithy.api#documentation": "

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE,\n JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

", "smithy.api#required": {} } }, @@ -15016,7 +15100,7 @@ "StepsList": { "target": "com.amazonaws.opensearch#UpgradeStepsList", "traits": { - "smithy.api#documentation": "

A list of each step performed as part of a specific upgrade or upgrade eligibility\n check.

" + "smithy.api#documentation": "

A list of each step performed as part of a specific upgrade or upgrade eligibility check.

" } } }, @@ -15103,7 +15187,7 @@ "Issues": { "target": "com.amazonaws.opensearch#Issues", "traits": { - "smithy.api#documentation": "

A list of strings containing detailed information about the errors encountered in a\n particular step.

" + "smithy.api#documentation": "

A list of strings containing detailed information about the errors encountered in a particular step.

" } }, "ProgressPercent": { @@ -15210,7 +15294,7 @@ "SecurityGroupIds": { "target": "com.amazonaws.opensearch#StringList", "traits": { - "smithy.api#documentation": "

The list of security group IDs associated with the VPC endpoints for the domain. If you do\n not provide a security group ID, OpenSearch Service uses the default security group for the\n VPC.

" + "smithy.api#documentation": "

The list of security group IDs associated with the VPC endpoints for the domain. If you do\n not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

" } } }, @@ -15554,7 +15638,7 @@ "target": "com.amazonaws.opensearch#StartTimeHours", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For\n example, 17 refers to 5:00 P.M. UTC.

", + "smithy.api#documentation": "

The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to\n 5:00 P.M. UTC.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/opensearchserverless.json b/codegen/sdk/aws-models/opensearchserverless.json index 780cf0ed972..25cd8a5c8e3 100644 --- a/codegen/sdk/aws-models/opensearchserverless.json +++ b/codegen/sdk/aws-models/opensearchserverless.json @@ -108,7 +108,7 @@ "type": { "target": "com.amazonaws.opensearchserverless#AccessPolicyType", "traits": { - "smithy.api#documentation": "

The type of access policy. Currently, the only available type is data.

" + "smithy.api#documentation": "

The type of access policy. Currently, the only available type is\n data.

" } }, "name": { @@ -211,7 +211,7 @@ "names": { "target": "com.amazonaws.opensearchserverless#CollectionNames", "traits": { - "smithy.api#documentation": "

A list of collection names. You can't provide names and IDs in the same request.

" + "smithy.api#documentation": "

A list of collection names. You can't provide names and IDs in the same\n request.

" } } } @@ -250,7 +250,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.

", + "smithy.api#documentation": "

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more\n information, see Viewing data lifecycle policies.

", "smithy.api#readonly": {} } }, @@ -306,7 +306,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

", + "smithy.api#documentation": "

Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see\n Viewing data lifecycle policies.

", "smithy.api#readonly": {} } }, @@ -362,7 +362,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns attributes for one or more VPC endpoints associated with the current account.\n For more information, see\n Access Amazon OpenSearch Serverless using an interface endpoint.

", + "smithy.api#documentation": "

Returns attributes for one or more VPC endpoints associated with the current account.\n For more information, see Access\n Amazon OpenSearch Serverless using an interface endpoint.

", "smithy.api#readonly": {} } }, @@ -766,7 +766,7 @@ } }, "traits": { - "smithy.api#documentation": "

When creating a resource, thrown when a resource with the same name already exists\n or is being created. When deleting a resource, thrown when the resource is not in\n the ACTIVE or FAILED state.

", + "smithy.api#documentation": "

When creating a resource, thrown when a resource with the same name already exists or\n is being created. When deleting a resource, thrown when the resource is not in the\n ACTIVE or FAILED state.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -794,7 +794,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections\n and the resources within them, and allow a user to access that data irrespective of the\n access mechanism or network source. For more information, see Data access\n control for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections\n and the resources within them, and allow a user to access that data irrespective of the\n access mechanism or network source. For more information, see Data\n access control for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -921,7 +921,7 @@ "kmsKeyArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the\n collection.

" } }, "standbyReplicas": { @@ -975,7 +975,7 @@ "tags": { "target": "com.amazonaws.opensearchserverless#Tags", "traits": { - "smithy.api#documentation": "

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

" + "smithy.api#documentation": "

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless\n collection.

" } }, "standbyReplicas": { @@ -1011,25 +1011,25 @@ "instanceArn": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterInstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

", + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance used to integrate with OpenSearch\n Serverless.

", "smithy.api#required": {} } }, "userAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterUserAttribute", "traits": { - "smithy.api#documentation": "

The user attribute for this IAM Identity Center integration. Defaults to UserId.

" + "smithy.api#documentation": "

The user attribute for this IAM Identity Center integration. Defaults to\n UserId.

" } }, "groupAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterGroupAttribute", "traits": { - "smithy.api#documentation": "

The group attribute for this IAM Identity Center integration. Defaults to GroupId.

" + "smithy.api#documentation": "

The group attribute for this IAM Identity Center integration. Defaults to\n GroupId.

" } } }, "traits": { - "smithy.api#documentation": "

Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.

" + "smithy.api#documentation": "

Describes IAM Identity Center options for creating an OpenSearch Serverless security\n configuration in the form of a key-value map.

" } }, "com.amazonaws.opensearchserverless#CreateLifecyclePolicy": { @@ -1055,7 +1055,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define\n the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.

", + "smithy.api#documentation": "

Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define\n the number of days or hours to retain the data on an OpenSearch Serverless index. For more information,\n see Creating data lifecycle policies.

", "smithy.api#idempotent": {} } }, @@ -1139,7 +1139,7 @@ } ], "traits": { - "smithy.api#documentation": "

Specifies a security configuration for OpenSearch Serverless. For more information, see\n SAML\n authentication for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Specifies a security configuration for OpenSearch Serverless. For more information, see SAML\n authentication for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -1169,13 +1169,19 @@ "samlOptions": { "target": "com.amazonaws.opensearchserverless#SamlConfigOptions", "traits": { - "smithy.api#documentation": "

Describes SAML options in in the form of a key-value map. This field is required if\n you specify saml for the type parameter.

" + "smithy.api#documentation": "

Describes SAML options in in the form of a key-value map. This field is required if\n you specify SAML for the type parameter.

" } }, "iamIdentityCenterOptions": { "target": "com.amazonaws.opensearchserverless#CreateIamIdentityCenterConfigOptions", "traits": { - "smithy.api#documentation": "

Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.

" + "smithy.api#documentation": "

Describes IAM Identity Center options in the form of a key-value map. This field is\n required if you specify iamidentitycenter for the type parameter.

" + } + }, + "iamFederationOptions": { + "target": "com.amazonaws.opensearchserverless#IamFederationConfigOptions", + "traits": { + "smithy.api#documentation": "

Describes IAM federation options in the form of a key-value map. This field is\n required if you specify iamFederation for the type\n parameter.

" } }, "clientToken": { @@ -1194,7 +1200,7 @@ "securityConfigDetail": { "target": "com.amazonaws.opensearchserverless#SecurityConfigDetail", "traits": { - "smithy.api#documentation": "

Details about the created security configuration.

" + "smithy.api#documentation": "

Details about the created security configuration.

" } } } @@ -1222,7 +1228,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a security policy to be used by one or more OpenSearch Serverless collections. Security\n policies provide access to a collection and its OpenSearch Dashboards endpoint from\n public networks or specific VPC endpoints. They also allow you to secure a collection\n with a KMS encryption key. For more information, see Network access\n for Amazon OpenSearch Serverless and Encryption at\n rest for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Creates a security policy to be used by one or more OpenSearch Serverless collections. Security\n policies provide access to a collection and its OpenSearch Dashboards endpoint from\n public networks or specific VPC endpoints. They also allow you to secure a collection\n with a KMS encryption key. For more information, see Network\n access for Amazon OpenSearch Serverless and Encryption\n at rest for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -1327,7 +1333,7 @@ } }, "traits": { - "smithy.api#documentation": "

Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see\n Access Amazon OpenSearch Serverless using an interface endpoint.

" + "smithy.api#documentation": "

Creation details for an OpenSearch Serverless-managed interface endpoint. For more information, see\n Access\n Amazon OpenSearch Serverless using an interface endpoint.

" } }, "com.amazonaws.opensearchserverless#CreateVpcEndpointRequest": { @@ -1609,7 +1615,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a security configuration for OpenSearch Serverless. For more information, see\n SAML\n authentication for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Deletes a security configuration for OpenSearch Serverless. For more information, see SAML\n authentication for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -1718,7 +1724,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see\n Access Amazon OpenSearch Serverless using an interface endpoint.

", + "smithy.api#documentation": "

Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access\n Amazon OpenSearch Serverless using an interface endpoint.

", "smithy.api#idempotent": {} } }, @@ -1803,19 +1809,19 @@ "resourceType": { "target": "com.amazonaws.opensearchserverless#ResourceType", "traits": { - "smithy.api#documentation": "

The type of OpenSearch Serverless resource. Currently, the only supported resource is index.

" + "smithy.api#documentation": "

The type of OpenSearch Serverless resource. Currently, the only supported resource is\n index.

" } }, "retentionPeriod": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.

" + "smithy.api#documentation": "

The minimum number of index retention in days or hours. This is an optional parameter\n that will return only if it’s set.

" } }, "noMinRetentionPeriod": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

The minimum number of index retention days set. That is an optional param that will return as true if the minimum number of days or \n hours is not set to a index resource.

" + "smithy.api#documentation": "

The minimum number of index retention days set. That is an optional param that will\n return as true if the minimum number of days or hours is not set to a index\n resource.

" } } }, @@ -1847,7 +1853,7 @@ "errorMessage": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A description of the error. For example, The specified Index resource is not found.

" + "smithy.api#documentation": "

A description of the error. For example, The specified Index resource is not\n found.

" } }, "errorCode": { @@ -1887,7 +1893,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns an OpenSearch Serverless access policy. For more information, see Data\n access control for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Returns an OpenSearch Serverless access policy. For more information, see Data\n access control for Amazon OpenSearch Serverless.

", "smithy.api#readonly": {} } }, @@ -2081,7 +2087,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access\n for Amazon OpenSearch Serverless and Encryption at\n rest for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Returns information about a configured OpenSearch Serverless security policy. For more information,\n see Network\n access for Amazon OpenSearch Serverless and Encryption\n at rest for Amazon OpenSearch Serverless.

", "smithy.api#readonly": {} } }, @@ -2115,6 +2121,26 @@ } } }, + "com.amazonaws.opensearchserverless#IamFederationConfigOptions": { + "type": "structure", + "members": { + "groupAttribute": { + "target": "com.amazonaws.opensearchserverless#iamFederationGroupAttribute", + "traits": { + "smithy.api#documentation": "

The group attribute for this IAM federation integration. This attribute is used to map\n identity provider groups to OpenSearch Serverless permissions.

" + } + }, + "userAttribute": { + "target": "com.amazonaws.opensearchserverless#iamFederationUserAttribute", + "traits": { + "smithy.api#documentation": "

The user attribute for this IAM federation integration. This attribute is used to\n identify users in the federated authentication process.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes IAM federation options for an OpenSearch Serverless security configuration\n in the form of a key-value map. These options define how OpenSearch Serverless\n integrates with external identity providers using federation.

" + } + }, "com.amazonaws.opensearchserverless#IamIdentityCenterApplicationArn": { "type": "string", "traits": { @@ -2131,42 +2157,42 @@ "instanceArn": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterInstanceArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

" + "smithy.api#documentation": "

The ARN of the IAM Identity Center instance used to integrate with OpenSearch\n Serverless.

" } }, "applicationArn": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterApplicationArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

" + "smithy.api#documentation": "

The ARN of the IAM Identity Center application used to integrate with OpenSearch\n Serverless.

" } }, "applicationName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

" + "smithy.api#documentation": "

The name of the IAM Identity Center application used to integrate with OpenSearch\n Serverless.

" } }, "applicationDescription": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

" + "smithy.api#documentation": "

The description of the IAM Identity Center application used to integrate with\n OpenSearch Serverless.

" } }, "userAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterUserAttribute", "traits": { - "smithy.api#documentation": "

The user attribute for this IAM Identity Center integration. Defaults to UserId\n

" + "smithy.api#documentation": "

The user attribute for this IAM Identity Center integration. Defaults to\n UserId\n

" } }, "groupAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterGroupAttribute", "traits": { - "smithy.api#documentation": "

The group attribute for this IAM Identity Center integration. Defaults to GroupId.

" + "smithy.api#documentation": "

The group attribute for this IAM Identity Center integration. Defaults to\n GroupId.

" } } }, "traits": { - "smithy.api#documentation": "

Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.

" + "smithy.api#documentation": "

Describes IAM Identity Center options for an OpenSearch Serverless security\n configuration in the form of a key-value map.

" } }, "com.amazonaws.opensearchserverless#IamIdentityCenterGroupAttribute": { @@ -2338,7 +2364,7 @@ "errorMessage": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A description of the error. For example, The specified Lifecycle Policy is not found.

" + "smithy.api#documentation": "

A description of the error. For example, The specified Lifecycle Policy is not\n found.

" } }, "errorCode": { @@ -2560,7 +2586,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If your initial ListAccessPolicies operation returns a\n nextToken, you can include the returned nextToken in\n subsequent ListAccessPolicies operations, which returns results in the next\n page.

" + "smithy.api#documentation": "

If your initial ListAccessPolicies operation returns a\n nextToken, you can include the returned nextToken in\n subsequent ListAccessPolicies operations, which returns results in the next\n page.

" } }, "maxResults": { @@ -2624,13 +2650,13 @@ "collectionFilters": { "target": "com.amazonaws.opensearchserverless#CollectionFilters", "traits": { - "smithy.api#documentation": "

A list of filter names and values that you can use for requests.

" + "smithy.api#documentation": "

A list of filter names and values that you can use for requests.

" } }, "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If your initial ListCollections operation returns a nextToken,\n you can include the returned nextToken in subsequent ListCollections operations,\n which returns results in the next page.

" + "smithy.api#documentation": "

If your initial ListCollections operation returns a\n nextToken, you can include the returned nextToken in\n subsequent ListCollections operations, which returns results in the next\n page.

" } }, "maxResults": { @@ -2657,7 +2683,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. \n The value of nextToken is a unique pagination token for each page. \n Make the call again using the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page.

" } } } @@ -2701,7 +2727,7 @@ "resources": { "target": "com.amazonaws.opensearchserverless#LifecycleResourceFilter", "traits": { - "smithy.api#documentation": "

Resource filters that policies can apply to. Currently, the only supported resource type is index.

", + "smithy.api#documentation": "

Resource filters that policies can apply to. Currently, the only supported resource\n type is index.

", "smithy.api#length": { "min": 1, "max": 1000 @@ -2711,13 +2737,13 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If your initial ListLifecyclePolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListLifecyclePolicies operations, which returns results in the next page.

" + "smithy.api#documentation": "

If your initial ListLifecyclePolicies operation returns a\n nextToken, you can include the returned nextToken in\n subsequent ListLifecyclePolicies operations, which returns results in the\n next page.

" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use use nextToken to get the next page of results. The default is 10.

", + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can\n use use nextToken to get the next page of results. The default is\n 10.

", "smithy.api#range": { "min": 1, "max": 100 @@ -2741,7 +2767,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

" + "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value\n of nextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page.

" } } }, @@ -2766,7 +2792,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about configured OpenSearch Serverless security configurations. For more information, see\n SAML\n authentication for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Returns information about configured OpenSearch Serverless security configurations. For more\n information, see SAML\n authentication for Amazon OpenSearch Serverless.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2788,7 +2814,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If your initial ListSecurityConfigs operation returns a\n nextToken, you can include the returned nextToken in\n subsequent ListSecurityConfigs operations, which returns results in the\n next page.

" + "smithy.api#documentation": "

If your initial ListSecurityConfigs operation returns a\n nextToken, you can include the returned nextToken in\n subsequent ListSecurityConfigs operations, which returns results in the\n next page.

" } }, "maxResults": { @@ -2859,7 +2885,7 @@ "resource": { "target": "com.amazonaws.opensearchserverless#ResourceFilter", "traits": { - "smithy.api#documentation": "

Resource filters (can be collection or indexes) that policies can apply to.

", + "smithy.api#documentation": "

Resource filters (can be collection or indexes) that policies can apply to.

", "smithy.api#length": { "min": 1, "max": 1000 @@ -2869,7 +2895,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If your initial ListSecurityPolicies operation returns a\n nextToken, you can include the returned nextToken in\n subsequent ListSecurityPolicies operations, which returns results in the\n next page.

" + "smithy.api#documentation": "

If your initial ListSecurityPolicies operation returns a\n nextToken, you can include the returned nextToken in\n subsequent ListSecurityPolicies operations, which returns results in the\n next page.

" } }, "maxResults": { @@ -2921,7 +2947,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

" + "smithy.api#documentation": "

Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging\n Amazon OpenSearch Serverless collections.

" } }, "com.amazonaws.opensearchserverless#ListTagsForResourceRequest": { @@ -2964,7 +2990,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current\n account. For more information, see\n Access Amazon OpenSearch Serverless using an interface endpoint.

", + "smithy.api#documentation": "

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current\n account. For more information, see Access\n Amazon OpenSearch Serverless using an interface endpoint.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2985,7 +3011,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If your initial ListVpcEndpoints operation returns a\n nextToken, you can include the returned nextToken in\n subsequent ListVpcEndpoints operations, which returns results in the next\n page.

" + "smithy.api#documentation": "

If your initial ListVpcEndpoints operation returns a\n nextToken, you can include the returned nextToken in\n subsequent ListVpcEndpoints operations, which returns results in the next\n page.

" } }, "maxResults": { @@ -3029,7 +3055,7 @@ } }, "traits": { - "smithy.api#documentation": "

Thrown when the collection you're attempting to create results in a number of search or indexing OCUs that exceeds the account limit.

", + "smithy.api#documentation": "

Thrown when the collection you're attempting to create results in a number of search\n or indexing OCUs that exceeds the account limit.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -3108,7 +3134,7 @@ }, "aws.protocols#awsJson1_0": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "

Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and\n security policies.

\n

OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for\n Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning,\n configuring, and tuning your OpenSearch clusters. It enables you to easily search and\n analyze petabytes of data without having to worry about the underlying infrastructure\n and data management.

\n

To learn more about OpenSearch Serverless, see What is\n Amazon OpenSearch Serverless?\n

", + "smithy.api#documentation": "

Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and\n security policies.

\n

OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for\n Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning,\n configuring, and tuning your OpenSearch clusters. It enables you to easily search and\n analyze petabytes of data without having to worry about the underlying infrastructure\n and data management.

\n

To learn more about OpenSearch Serverless, see What is\n Amazon OpenSearch Serverless?\n

", "smithy.api#title": "OpenSearch Service Serverless", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -3880,7 +3906,7 @@ "openSearchServerlessEntityId": { "target": "com.amazonaws.opensearchserverless#openSearchServerlessEntityId", "traits": { - "smithy.api#documentation": "

Custom entity id attribute to override default entity id for this saml integration.

" + "smithy.api#documentation": "

Custom entity ID attribute to override the default entity ID for this SAML\n integration.

" } }, "sessionTimeout": { @@ -3973,6 +3999,12 @@ "smithy.api#documentation": "

Describes IAM Identity Center options in the form of a key-value map.

" } }, + "iamFederationOptions": { + "target": "com.amazonaws.opensearchserverless#IamFederationConfigOptions", + "traits": { + "smithy.api#documentation": "

Describes IAM federation options in the form of a key-value map. Contains\n configuration details about how OpenSearch Serverless integrates with external identity\n providers through federation.

" + } + }, "createdDate": { "target": "smithy.api#Long", "traits": { @@ -3987,7 +4019,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about a security configuration for OpenSearch Serverless.

" + "smithy.api#documentation": "

Details about a security configuration for OpenSearch Serverless.

" } }, "com.amazonaws.opensearchserverless#SecurityConfigId": { @@ -4076,6 +4108,11 @@ "name": "iamidentitycenter", "value": "iamidentitycenter", "documentation": "iam identity center" + }, + { + "name": "iamfederation", + "value": "iamfederation", + "documentation": "iam federation" } ] } @@ -4304,7 +4341,7 @@ } }, "traits": { - "smithy.api#documentation": "

Thrown when you attempt to create more resources than the service allows based on service quotas.

", + "smithy.api#documentation": "

Thrown when you attempt to create more resources than the service allows based on\n service quotas.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -4417,7 +4454,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

" + "smithy.api#documentation": "

Associates tags with an OpenSearch Serverless resource. For more information, see Tagging\n Amazon OpenSearch Serverless collections.

" } }, "com.amazonaws.opensearchserverless#TagResourceRequest": { @@ -4487,7 +4524,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

" + "smithy.api#documentation": "

Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging\n Amazon OpenSearch Serverless collections.

" } }, "com.amazonaws.opensearchserverless#UntagResourceRequest": { @@ -4536,7 +4573,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an OpenSearch Serverless access policy. For more information, see Data\n access control for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Updates an OpenSearch Serverless access policy. For more information, see Data\n access control for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -4614,7 +4651,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more\n information, see Managing capacity limits for Amazon OpenSearch Serverless.

" + "smithy.api#documentation": "

Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more\n information, see Managing\n capacity limits for Amazon OpenSearch Serverless.

" } }, "com.amazonaws.opensearchserverless#UpdateAccountSettingsRequest": { @@ -4631,7 +4668,7 @@ "accountSettingsDetail": { "target": "com.amazonaws.opensearchserverless#AccountSettingsDetail", "traits": { - "smithy.api#documentation": "

OpenSearch Serverless-related settings for the current Amazon Web Services account.

" + "smithy.api#documentation": "

OpenSearch Serverless-related settings for the current Amazon Web Services account.

" } } } @@ -4762,18 +4799,18 @@ "userAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterUserAttribute", "traits": { - "smithy.api#documentation": "

The user attribute for this IAM Identity Center integration. Defaults to UserId.

" + "smithy.api#documentation": "

The user attribute for this IAM Identity Center integration. Defaults to\n UserId.

" } }, "groupAttribute": { "target": "com.amazonaws.opensearchserverless#IamIdentityCenterGroupAttribute", "traits": { - "smithy.api#documentation": "

The group attribute for this IAM Identity Center integration. Defaults to GroupId.

" + "smithy.api#documentation": "

The group attribute for this IAM Identity Center integration. Defaults to\n GroupId.

" } } }, "traits": { - "smithy.api#documentation": "

Describes IAM Identity Center options for updating an OpenSearch Serverless security configuration in the form of a key-value map.

" + "smithy.api#documentation": "

Describes IAM Identity Center options for updating an OpenSearch Serverless security\n configuration in the form of a key-value map.

" } }, "com.amazonaws.opensearchserverless#UpdateLifecyclePolicy": { @@ -4812,7 +4849,7 @@ "type": { "target": "com.amazonaws.opensearchserverless#LifecyclePolicyType", "traits": { - "smithy.api#documentation": "

The type of lifecycle policy.

", + "smithy.api#documentation": "

The type of lifecycle policy.

", "smithy.api#required": {} } }, @@ -4892,7 +4929,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a security configuration for OpenSearch Serverless. For more information, see\n SAML\n authentication for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Updates a security configuration for OpenSearch Serverless. For more information, see SAML\n authentication for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -4931,6 +4968,12 @@ "smithy.api#documentation": "

Describes IAM Identity Center options in the form of a key-value map.

" } }, + "iamFederationOptions": { + "target": "com.amazonaws.opensearchserverless#IamFederationConfigOptions", + "traits": { + "smithy.api#documentation": "

Describes IAM federation options in the form of a key-value map for updating an\n existing security configuration. Use this field to modify IAM federation settings for\n the security configuration.

" + } + }, "clientToken": { "target": "com.amazonaws.opensearchserverless#ClientToken", "traits": { @@ -4947,7 +4990,7 @@ "securityConfigDetail": { "target": "com.amazonaws.opensearchserverless#SecurityConfigDetail", "traits": { - "smithy.api#documentation": "

Details about the updated security configuration.

" + "smithy.api#documentation": "

Details about the updated security configuration.

" } } } @@ -4978,7 +5021,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an OpenSearch Serverless security policy. For more information, see Network access\n for Amazon OpenSearch Serverless and Encryption at\n rest for Amazon OpenSearch Serverless.

", + "smithy.api#documentation": "

Updates an OpenSearch Serverless security policy. For more information, see Network\n access for Amazon OpenSearch Serverless and Encryption\n at rest for Amazon OpenSearch Serverless.

", "smithy.api#idempotent": {} } }, @@ -5059,7 +5102,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an OpenSearch Serverless-managed interface endpoint. For more information, see\n Access Amazon OpenSearch Serverless using an interface endpoint.

", + "smithy.api#documentation": "

Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access\n Amazon OpenSearch Serverless using an interface endpoint.

", "smithy.api#idempotent": {} } }, @@ -5412,6 +5455,26 @@ "smithy.api#pattern": "^vpc-[0-9a-z]*$" } }, + "com.amazonaws.opensearchserverless#iamFederationGroupAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_.:/=+\\-@]*$" + } + }, + "com.amazonaws.opensearchserverless#iamFederationUserAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_.:/=+\\-@]*$" + } + }, "com.amazonaws.opensearchserverless#openSearchServerlessEntityId": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/osis.json b/codegen/sdk/aws-models/osis.json index 865663460ef..e65a6910f52 100644 --- a/codegen/sdk/aws-models/osis.json +++ b/codegen/sdk/aws-models/osis.json @@ -1065,6 +1065,12 @@ "traits": { "smithy.api#documentation": "

List of tags to add to the pipeline upon creation.

" } + }, + "PipelineRoleArn": { + "target": "com.amazonaws.osis#PipelineRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that provides\n the required permissions for a pipeline to read from the source and write to the sink.\n For more information, see Setting up roles and users in Amazon OpenSearch Ingestion.

" + } } }, "traits": { @@ -1796,6 +1802,12 @@ "traits": { "smithy.api#documentation": "

A list of tags associated with the given pipeline.

" } + }, + "PipelineRoleArn": { + "target": "com.amazonaws.osis#PipelineRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that provides\n the required permissions for a pipeline to read from the source and write to the sink.

" + } } }, "traits": { @@ -1945,6 +1957,16 @@ "smithy.api#pattern": "^[a-z][a-z0-9\\-]+$" } }, + "com.amazonaws.osis#PipelineRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b|aws\\-iso\\-e|aws\\-iso\\-f):iam::[0-9]+:role\\/.*$" + } + }, "com.amazonaws.osis#PipelineStatus": { "type": "enum", "members": { @@ -2601,6 +2623,12 @@ "traits": { "smithy.api#documentation": "

Key-value pairs to configure encryption for data that is written to a persistent buffer.

" } + }, + "PipelineRoleArn": { + "target": "com.amazonaws.osis#PipelineRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that provides\n the required permissions for a pipeline to read from the source and write to the sink.\n For more information, see Setting up roles and users in Amazon OpenSearch Ingestion.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/outposts.json b/codegen/sdk/aws-models/outposts.json index fdb5ce7507c..00238a21373 100644 --- a/codegen/sdk/aws-models/outposts.json +++ b/codegen/sdk/aws-models/outposts.json @@ -276,7 +276,7 @@ "AssetId": { "target": "com.amazonaws.outposts#AssetId", "traits": { - "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" + "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or\n an Outposts server configuration.

" } }, "RackId": { @@ -326,7 +326,7 @@ "AssetId": { "target": "com.amazonaws.outposts#AssetId", "traits": { - "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" + "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an\n Outposts server configuration.

" } }, "AccountId": { @@ -803,7 +803,7 @@ "AssetId": { "target": "com.amazonaws.outposts#AssetId", "traits": { - "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" + "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an\n Outposts server configuration.

" } }, "CapacityTaskStatus": { @@ -1691,7 +1691,7 @@ "AssetId": { "target": "com.amazonaws.outposts#AssetId", "traits": { - "smithy.api#documentation": "

The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" + "smithy.api#documentation": "

The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts\n rack or an Outposts server configuration.

" } }, "RequestedInstancePools": { @@ -1716,7 +1716,7 @@ "CapacityTaskStatus": { "target": "com.amazonaws.outposts#CapacityTaskStatus", "traits": { - "smithy.api#documentation": "

Status of the capacity task.

\n

A capacity task can have one of the following statuses:

\n
    \n
  • \n

    \n REQUESTED - The capacity task was created and is awaiting the next step\n by Amazon Web Services Outposts.

    \n
    • \n
  • \n

    \n IN_PROGRESS - The capacity task is running and cannot be cancelled.

    \n
    • \n
  • \n

    \n FAILED - The capacity task could not be completed.

    \n
    • \n
  • \n

    \n COMPLETED - The capacity task has completed successfully.

    \n
    • \n
  • \n

    \n WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.

    \n
    • \n
  • \n

    \n CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in the process of cleaning up resources.

    \n
    • \n
  • \n

    \n CANCELLED - The capacity task is cancelled.

    \n
    • \n
" + "smithy.api#documentation": "

Status of the capacity task.

\n

A capacity task can have one of the following statuses:

\n
    \n
  • \n

    \n REQUESTED - The capacity task was created and is awaiting the next step\n by Amazon Web Services Outposts.

    \n
    • \n
  • \n

    \n IN_PROGRESS - The capacity task is running and cannot be\n cancelled.

    \n
    • \n
  • \n

    \n FAILED - The capacity task could not be completed.

    \n
    • \n
  • \n

    \n COMPLETED - The capacity task has completed successfully.

    \n
    • \n
  • \n

    \n WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You\n must stop the recommended EC2 running instances to free up capacity for the task to\n run.

    \n
    • \n
  • \n

    \n CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in\n the process of cleaning up resources.

    \n
    • \n
  • \n

    \n CANCELLED - The capacity task is cancelled.

    \n
    • \n
" } }, "Failed": { @@ -1763,6 +1763,9 @@ "target": "com.amazonaws.outposts#GetCatalogItemOutput" }, "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, { "target": "com.amazonaws.outposts#InternalServerException" }, @@ -1965,13 +1968,98 @@ } } }, + "com.amazonaws.outposts#GetOutpostBillingInformation": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#GetOutpostBillingInformationInput" + }, + "output": { + "target": "com.amazonaws.outposts#GetOutpostBillingInformationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets current and historical billing information about the specified Outpost.

", + "smithy.api#http": { + "method": "GET", + "uri": "/outpost/{OutpostIdentifier}/billing-information", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Subscriptions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.outposts#GetOutpostBillingInformationInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.outposts#Token", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.outposts#MaxResults1000", + "traits": { + "smithy.api#httpQuery": "MaxResults" + } + }, + "OutpostIdentifier": { + "target": "com.amazonaws.outposts#OutpostIdentifier", + "traits": { + "smithy.api#documentation": "

The ID or ARN of the Outpost.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.outposts#GetOutpostBillingInformationOutput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.outposts#Token" + }, + "Subscriptions": { + "target": "com.amazonaws.outposts#SubscriptionList", + "traits": { + "smithy.api#documentation": "

The subscription details for the specified Outpost.

" + } + }, + "ContractEndDate": { + "target": "com.amazonaws.outposts#String", + "traits": { + "smithy.api#documentation": "

The date the current contract term ends for the specified Outpost. You must start the renewal or\n decommission process at least 5 business days before the current term for your\n Amazon Web Services Outposts ends. Failing to complete these steps at least 5 business days before the\n current term ends might result in unanticipated charges.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.outposts#GetOutpostInput": { "type": "structure", "members": { "OutpostId": { "target": "com.amazonaws.outposts#OutpostId", "traits": { - "smithy.api#documentation": "

The ID or ARN of the Outpost.

", + "smithy.api#documentation": "

The ID or ARN of the Outpost.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2138,7 +2226,7 @@ "AssetId": { "target": "com.amazonaws.outposts#AssetIdInput", "traits": { - "smithy.api#documentation": "

The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

", + "smithy.api#documentation": "

The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts\n rack or an Outposts server configuration.

", "smithy.api#httpQuery": "AssetId" } }, @@ -2559,7 +2647,7 @@ "AssetId": { "target": "com.amazonaws.outposts#AssetId", "traits": { - "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" + "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or\n an Outposts server configuration.

" } }, "MacAddressList": { @@ -3092,6 +3180,9 @@ "target": "com.amazonaws.outposts#ListCatalogItemsOutput" }, "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, { "target": "com.amazonaws.outposts#InternalServerException" }, @@ -3589,6 +3680,9 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.outposts#NullableDouble": { + "type": "double" + }, "com.amazonaws.outposts#OpticalStandard": { "type": "enum", "members": { @@ -3744,6 +3838,12 @@ "smithy.api#pattern": "^oo-[a-f0-9]{17}$" } }, + "com.amazonaws.outposts#OrderIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#String" + } + }, "com.amazonaws.outposts#OrderStatus": { "type": "enum", "members": { @@ -4060,6 +4160,9 @@ { "target": "com.amazonaws.outposts#GetOutpost" }, + { + "target": "com.amazonaws.outposts#GetOutpostBillingInformation" + }, { "target": "com.amazonaws.outposts#GetOutpostInstanceTypes" }, @@ -5630,7 +5733,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts the specified capacity task. You can have one active capacity task for each order and each Outpost.

", + "smithy.api#documentation": "

Starts the specified capacity task. You can have one active capacity task for each order\n and each Outpost.

", "smithy.api#http": { "method": "POST", "uri": "/outposts/{OutpostIdentifier}/capacity", @@ -5658,7 +5761,7 @@ "AssetId": { "target": "com.amazonaws.outposts#AssetIdInput", "traits": { - "smithy.api#documentation": "

The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" + "smithy.api#documentation": "

The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts\n rack or an Outposts server configuration.

" } }, "InstancePools": { @@ -5716,7 +5819,7 @@ "AssetId": { "target": "com.amazonaws.outposts#AssetId", "traits": { - "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

" + "smithy.api#documentation": "

The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an\n Outposts server configuration.

" } }, "RequestedInstancePools": { @@ -5904,6 +6007,114 @@ "smithy.api#pattern": "^[\\S \\n]+$" } }, + "com.amazonaws.outposts#Subscription": { + "type": "structure", + "members": { + "SubscriptionId": { + "target": "com.amazonaws.outposts#String", + "traits": { + "smithy.api#documentation": "

The ID of the subscription that appears on the Amazon Web Services Billing Center console.

" + } + }, + "SubscriptionType": { + "target": "com.amazonaws.outposts#SubscriptionType", + "traits": { + "smithy.api#documentation": "

The type of subscription which can be one of the following:

\n
    \n
  • \n

    \n ORIGINAL - The first order on the Amazon Web Services Outposts.

    \n
    • \n
  • \n

    \n RENEWAL - Renewal requests, both month to month and\n longer term.

    \n
    • \n
  • \n

    \n CAPACITY_INCREASE - Capacity scaling orders.

    \n
    • \n
" + } + }, + "SubscriptionStatus": { + "target": "com.amazonaws.outposts#SubscriptionStatus", + "traits": { + "smithy.api#documentation": "

The status of subscription which can be one of the following:

\n
    \n
  • \n

    \n INACTIVE - Subscription requests that are\n inactive.

    \n
    • \n
  • \n

    \n ACTIVE - Subscription requests that are in progress\n and have an end date in the future.

    \n
    • \n
  • \n

    \n CANCELLED - Subscription requests that are\n cancelled.

    \n
    • \n
" + } + }, + "OrderIds": { + "target": "com.amazonaws.outposts#OrderIdList", + "traits": { + "smithy.api#documentation": "

The order ID for your subscription.

" + } + }, + "BeginDate": { + "target": "com.amazonaws.outposts#ISO8601Timestamp", + "traits": { + "smithy.api#documentation": "

The date your subscription starts.

" + } + }, + "EndDate": { + "target": "com.amazonaws.outposts#ISO8601Timestamp", + "traits": { + "smithy.api#documentation": "

The date your subscription ends.

" + } + }, + "MonthlyRecurringPrice": { + "target": "com.amazonaws.outposts#NullableDouble", + "traits": { + "smithy.api#documentation": "

The amount you are billed each month in the subscription period.

" + } + }, + "UpfrontPrice": { + "target": "com.amazonaws.outposts#NullableDouble", + "traits": { + "smithy.api#documentation": "

The amount billed when the subscription is created. This is a one-time charge.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about your Amazon Web Services Outposts subscriptions.

" + } + }, + "com.amazonaws.outposts#SubscriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#Subscription" + } + }, + "com.amazonaws.outposts#SubscriptionStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + } + } + }, + "com.amazonaws.outposts#SubscriptionType": { + "type": "enum", + "members": { + "ORIGINAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORIGINAL" + } + }, + "RENEWAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RENEWAL" + } + }, + "CAPACITY_INCREASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAPACITY_INCREASE" + } + } + } + }, "com.amazonaws.outposts#SupportedHardwareType": { "type": "enum", "members": { @@ -6458,7 +6669,7 @@ "PowerConnector": { "target": "com.amazonaws.outposts#PowerConnector", "traits": { - "smithy.api#documentation": "

The power connector that Amazon Web Services should plan to provide for connections to the hardware.\n Note the correlation between PowerPhase and PowerConnector.

\n
    \n
  • \n

    Single-phase AC feed

    \n
      \n
    • \n

      \n L6-30P – (common in US); 30A; single phase

      \n
      • \n
    • \n

      \n IEC309 (blue) – P+N+E, 6hr; 32 A; single\n phase

      \n
      • \n
    \n
    • \n
  • \n

    Three-phase AC feed

    \n
      \n
    • \n

      \n AH530P7W (red) – 3P+N+E, 7hr; 30A; three phase

      \n
      • \n
    • \n

      \n AH532P6W (red) – 3P+N+E, 6hr; 32A; three phase

      \n
      • \n
    • \n

      \n CS8365C – (common in US); 3P+E, 50A; three phase

      \n
      • \n
    \n
    • \n
" + "smithy.api#documentation": "

The power connector that Amazon Web Services should plan to provide for connections to the hardware.\n Note the correlation between PowerPhase and PowerConnector.

\n
    \n
  • \n

    Single-phase AC feed

    \n
      \n
    • \n

      \n L6-30P – (common in US); 30A; single phase

      \n
      • \n
    • \n

      \n IEC309 (blue) – P+N+E, 6hr; 32 A; single\n phase

      \n
      • \n
    \n
    • \n
  • \n

    Three-phase AC feed

    \n
      \n
    • \n

      \n AH530P7W (red) – 3P+N+E, 7hr; 30A; three\n phase

      \n
      • \n
    • \n

      \n AH532P6W (red) – 3P+N+E, 6hr; 32A; three\n phase

      \n
      • \n
    • \n

      \n CS8365C – (common in US); 3P+E, 50A; three\n phase

      \n
      • \n
    \n
    • \n
" } }, "PowerFeedDrop": { diff --git a/codegen/sdk/aws-models/pcs.json b/codegen/sdk/aws-models/pcs.json index 819b5194d00..f71421dc502 100644 --- a/codegen/sdk/aws-models/pcs.json +++ b/codegen/sdk/aws-models/pcs.json @@ -2176,14 +2176,20 @@ "privateIpAddress": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The endpoint's private IP address.

Example: 2.2.2.2

", + "smithy.api#documentation": "

For clusters that use IPv4, this is the endpoint's private IP address.

Example: 10.1.2.3

For clusters configured to use IPv6, this is an empty string.

", "smithy.api#required": {} } }, "publicIpAddress": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The endpoint's public IP address.

Example: 1.1.1.1

" + "smithy.api#documentation": "

The endpoint's public IP address.

Example: 192.0.2.1

" + } + }, + "ipv6Address": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The endpoint's IPv6 address.

Example: 2001:db8::1

" } }, "port": { @@ -2943,6 +2949,23 @@ } } }, + "com.amazonaws.pcs#NetworkType": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV6" + } + } + } + }, "com.amazonaws.pcs#Networking": { "type": "structure", "members": { @@ -2955,7 +2978,13 @@ "securityGroupIds": { "target": "com.amazonaws.pcs#SecurityGroupIdList", "traits": { - "smithy.api#documentation": "

The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.

The following rules are required:

  • Inbound rule 1

    • Protocol: All

    • Ports: All

    • Source: Self

  • Outbound rule 1

    • Protocol: All

    • Ports: All

    • Destination: 0.0.0.0/0 (IPv4)

  • Outbound rule 2

    • Protocol: All

    • Ports: All

    • Destination: Self

" + "smithy.api#documentation": "

The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.

The following rules are required:

  • Inbound rule 1

    • Protocol: All

    • Ports: All

    • Source: Self

  • Outbound rule 1

    • Protocol: All

    • Ports: All

    • Destination: 0.0.0.0/0 (IPv4) or ::/0 (IPv6)

  • Outbound rule 2

    • Protocol: All

    • Ports: All

    • Destination: Self

" + } + }, + "networkType": { + "target": "com.amazonaws.pcs#NetworkType", + "traits": { + "smithy.api#documentation": "

The IP address version the cluster uses. The default is IPV4.

" } } }, @@ -2977,6 +3006,12 @@ "traits": { "smithy.api#documentation": "

A list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.

" } + }, + "networkType": { + "target": "com.amazonaws.pcs#NetworkType", + "traits": { + "smithy.api#documentation": "

The IP address version the cluster uses. The default is IPV4.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/quicksight.json b/codegen/sdk/aws-models/quicksight.json index e2f25182683..efa948f619a 100644 --- a/codegen/sdk/aws-models/quicksight.json +++ b/codegen/sdk/aws-models/quicksight.json @@ -14405,6 +14405,12 @@ "traits": { "smithy.api#documentation": "

The parameters that are required to connect to a Google BigQuery data source.

" } + }, + "ImpalaParameters": { + "target": "com.amazonaws.quicksight#ImpalaParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Impala.

" + } } }, "traits": { @@ -31340,6 +31346,41 @@ "smithy.api#documentation": "

A static file that contains an image.

" } }, + "com.amazonaws.quicksight#ImpalaParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

The host name of the Impala data source.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

The port of the Impala data source.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

The database of the Impala data source.

" + } + }, + "SqlEndpointPath": { + "target": "com.amazonaws.quicksight#SqlEndpointPath", + "traits": { + "smithy.api#documentation": "

The HTTP path of the Impala data source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Impala data source.

" + } + }, "com.amazonaws.quicksight#IncludeFolderMembers": { "type": "enum", "members": { diff --git a/codegen/sdk/aws-models/rds.json b/codegen/sdk/aws-models/rds.json index 174c02809ee..f407a7920fb 100644 --- a/codegen/sdk/aws-models/rds.json +++ b/codegen/sdk/aws-models/rds.json @@ -7610,6 +7610,12 @@ "ServerlessV2ScalingConfiguration": { "target": "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo" }, + "ServerlessV2PlatformVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "

The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the Amazon Aurora User Guide.

" + } + }, "NetworkType": { "target": "com.amazonaws.rds#String", "traits": { @@ -7675,7 +7681,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, \n RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, \n RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

\n

For a Multi-AZ DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, RebootDBCluster, \n RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

\n

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, \n RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, \n RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

\n

For a Multi-AZ DB cluster, this data type is used as a response element in the operations \n CreateDBCluster, DeleteDBCluster, DescribeDBClusters, \n FailoverDBCluster, ModifyDBCluster, RebootDBCluster, \n RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

\n

For more information on Amazon Aurora DB clusters, see \n \n What is Amazon Aurora? in the Amazon Aurora User Guide.\n

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" } }, "com.amazonaws.rds#DBClusterAlreadyExistsFault": { @@ -29721,18 +29727,18 @@ "MinCapacity": { "target": "com.amazonaws.rds#DoubleOptional", "traits": { - "smithy.api#documentation": "

If the minimum capacity is 0 ACUs, the engine version supports the automatic pause/resume\n feature of Aurora Serverless v2.

" + "smithy.api#documentation": "

If the minimum capacity is 0 ACUs, the engine version or platform version supports the automatic pause/resume\n feature of Aurora Serverless v2.

" } }, "MaxCapacity": { "target": "com.amazonaws.rds#DoubleOptional", "traits": { - "smithy.api#documentation": "

\n Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version.\n Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be\n 256 or 128.\n

" + "smithy.api#documentation": "

\n Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version or platform version.\n Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be\n 256 or 128.\n

" } } }, "traits": { - "smithy.api#documentation": "

Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions.\n You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded\n DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version\n supports certain Aurora Serverless v2 features before you attempt to use those features.\n

" + "smithy.api#documentation": "

Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions and platform versions.\n You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded\n DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version\n supports certain Aurora Serverless v2 features before you attempt to use those features.\n

" } }, "com.amazonaws.rds#ServerlessV2ScalingConfiguration": { @@ -29747,7 +29753,7 @@ "MaxCapacity": { "target": "com.amazonaws.rds#DoubleOptional", "traits": { - "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value\n that you can use is 256 for recent Aurora versions, or 128 for older versions.

" + "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value\n that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported.

" } }, "SecondsUntilAutoPause": { @@ -29773,7 +29779,7 @@ "MaxCapacity": { "target": "com.amazonaws.rds#DoubleOptional", "traits": { - "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value\n that you can use is 256 for recent Aurora versions, or 128 for older versions.

" + "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value\n that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported.

" } }, "SecondsUntilAutoPause": { diff --git a/codegen/sdk/aws-models/s3-control.json b/codegen/sdk/aws-models/s3-control.json index a7110dfeb7f..b653fba6d56 100644 --- a/codegen/sdk/aws-models/s3-control.json +++ b/codegen/sdk/aws-models/s3-control.json @@ -10529,6 +10529,12 @@ "traits": { "smithy.api#documentation": "

For directory buckets, you can filter access control to specific prefixes, API\n operations, or a combination of both. For more information, see Managing access to shared datasets in directory buckets with\n access points in the Amazon S3 User Guide.

\n \n

Scope is only supported for access points attached to directory buckets.

\n " } + }, + "Tags": { + "target": "com.amazonaws.s3control#TagList", + "traits": { + "smithy.api#documentation": "

An array of tags that you can apply to an access point. Tags are key-value pairs of metadata used to control access to your access points. For more information about tags, see Using tags with Amazon S3. For information about tagging access points, see Using tags for attribute-based access control (ABAC).

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index 71c48d69d95..87aef299171 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -246,6 +246,44 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#AddClusterNodeSpecification": { + "type": "structure", + "members": { + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the instance group to which you want to add nodes.

", + "smithy.api#required": {} + } + }, + "IncrementTargetCountBy": { + "target": "com.amazonaws.sagemaker#BatchAddIncrementCount", + "traits": { + "smithy.api#documentation": "

The number of nodes to add to the specified instance group. The total number of nodes across all instance groups in a single request cannot exceed 50.

", + "smithy.api#range": { + "min": 1, + "max": 50 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies an instance group and the number of nodes to add to it.

" + } + }, + "com.amazonaws.sagemaker#AddClusterNodeSpecificationList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AddClusterNodeSpecification" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.sagemaker#AddTags": { "type": "operation", "input": { @@ -308,6 +346,20 @@ } } }, + "com.amazonaws.sagemaker#AdditionalEnis": { + "type": "structure", + "members": { + "EfaEnis": { + "target": "com.amazonaws.sagemaker#EfaEnis", + "traits": { + "smithy.api#documentation": "

A list of Elastic Fabric Adapter (EFA) ENIs associated with the instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about additional Elastic Network Interfaces (ENIs) associated with an instance.

" + } + }, "com.amazonaws.sagemaker#AdditionalInferenceSpecificationDefinition": { "type": "structure", "members": { @@ -934,7 +986,7 @@ "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Semantic Segmentation Adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation

Semantic Segmentation Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation

Bounding Box Adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox

Bounding Box Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking

3D Point Cloud Object Detection Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection

3D Point Cloud Object Tracking Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects that appear in a sequence of 3D point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation Adjustment - Use this task type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Semantic Segmentation Adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation

Semantic Segmentation Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation

Bounding Box Adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox

Bounding Box Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking

3D Point Cloud Object Detection Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection

3D Point Cloud Object Tracking Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects that appear in a sequence of 3D point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation Adjustment - Use this task type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation

Generative AI/Custom - Direct passthrough of output data without any transformation.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-PassThrough

  • arn:aws:lambda:us-east-2:266458841044:function:ACS-PassThrough

  • arn:aws:lambda:us-west-2:081040173940:function:ACS-PassThrough

  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-PassThrough

  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-PassThrough

  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-PassThrough

  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-PassThrough

  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-PassThrough

  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-PassThrough

  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-PassThrough

  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-PassThrough

  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-PassThrough

", "smithy.api#required": {} } } @@ -2964,6 +3016,111 @@ "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" } }, + "com.amazonaws.sagemaker#AttachClusterNodeVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#AttachClusterNodeVolumeRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#AttachClusterNodeVolumeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches your Amazon Elastic Block Store (Amazon EBS) volume to a node in your EKS-orchestrated HyperPod cluster.

This API works with the Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver to manage the lifecycle of persistent storage in your HyperPod EKS clusters.

" + } + }, + "com.amazonaws.sagemaker#AttachClusterNodeVolumeRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster containing the target node. Your cluster must use EKS as the orchestration and be in the InService state.

", + "smithy.api#required": {} + } + }, + "NodeId": { + "target": "com.amazonaws.sagemaker#ClusterNodeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the cluster node to which you want to attach the volume. The node must belong to your specified HyperPod cluster and cannot be part of a Restricted Instance Group (RIG).

", + "smithy.api#required": {} + } + }, + "VolumeId": { + "target": "com.amazonaws.sagemaker#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of your EBS volume to attach. The volume must be in the available state.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#AttachClusterNodeVolumeResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume attachment operation was performed.

", + "smithy.api#required": {} + } + }, + "NodeId": { + "target": "com.amazonaws.sagemaker#ClusterNodeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the cluster node where your volume was attached.

", + "smithy.api#required": {} + } + }, + "VolumeId": { + "target": "com.amazonaws.sagemaker#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of your EBS volume that was attached.

", + "smithy.api#required": {} + } + }, + "AttachTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The timestamp when the volume attachment operation was initiated by the SageMaker HyperPod service.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#VolumeAttachmentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of your volume attachment operation.

", + "smithy.api#required": {} + } + }, + "DeviceName": { + "target": "com.amazonaws.sagemaker#VolumeDeviceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The device name assigned to your attached volume on the target instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#AttributeName": { "type": "string", "traits": { @@ -4745,6 +4902,158 @@ "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, + "com.amazonaws.sagemaker#BatchAddClusterNodes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#BatchAddClusterNodesRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#BatchAddClusterNodesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Adds nodes to a HyperPod cluster by incrementing the target count for one or more instance groups. This operation returns a unique NodeLogicalId for each node being added, which can be used to track the provisioning status of the node. This API provides a safer alternative to UpdateCluster for scaling operations by avoiding unintended configuration changes.

This API is only supported for clusters using Continuous as the NodeProvisioningMode.

" + } + }, + "com.amazonaws.sagemaker#BatchAddClusterNodesError": { + "type": "structure", + "members": { + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#InstanceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the instance group for which the error occurred.

", + "smithy.api#required": {} + } + }, + "ErrorCode": { + "target": "com.amazonaws.sagemaker#BatchAddClusterNodesErrorCode", + "traits": { + "smithy.api#documentation": "

The error code associated with the failure. Possible values include InstanceGroupNotFound and InvalidInstanceGroupState.

", + "smithy.api#required": {} + } + }, + "FailedCount": { + "target": "com.amazonaws.sagemaker#BatchAddFailureCount", + "traits": { + "smithy.api#documentation": "

The number of nodes that failed to be added to the specified instance group.

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#documentation": "

A descriptive message providing additional details about the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an error that occurred during the node addition operation.

" + } + }, + "com.amazonaws.sagemaker#BatchAddClusterNodesErrorCode": { + "type": "enum", + "members": { + "INSTANCE_GROUP_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceGroupNotFound" + } + }, + "INVALID_INSTANCE_GROUP_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidInstanceGroupStatus" + } + } + } + }, + "com.amazonaws.sagemaker#BatchAddClusterNodesErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#BatchAddClusterNodesError" + } + }, + "com.amazonaws.sagemaker#BatchAddClusterNodesRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#documentation": "

The name of the HyperPod cluster to which you want to add nodes.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 8 hours. If you retry the request with the same client token within this timeframe and the same parameters, the API returns the same set of NodeLogicalIds with their latest status.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#length": { + "max": 64 + }, + "smithy.api#pattern": "^[\\x21-\\x7E]+$" + } + }, + "NodesToAdd": { + "target": "com.amazonaws.sagemaker#AddClusterNodeSpecificationList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of instance groups and the number of nodes to add to each. You can specify up to 5 instance groups in a single request, with a maximum of 50 nodes total across all instance groups.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#BatchAddClusterNodesResponse": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.sagemaker#NodeAdditionResultList", + "traits": { + "smithy.api#documentation": "

A list of NodeLogicalIDs that were successfully added to the cluster. The NodeLogicalID is unique per cluster and does not change between instance replacements. Each entry includes a NodeLogicalId that can be used to track the node's provisioning status (with DescribeClusterNode), the instance group name, and the current status of the node.

", + "smithy.api#required": {} + } + }, + "Failed": { + "target": "com.amazonaws.sagemaker#BatchAddClusterNodesErrorList", + "traits": { + "smithy.api#documentation": "

A list of errors that occurred during the node addition operation. Each entry includes the instance group name, error code, number of failed additions, and an error message.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#BatchAddFailureCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.sagemaker#BatchAddIncrementCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.sagemaker#BatchDataCaptureConfig": { "type": "structure", "members": { @@ -4773,6 +5082,50 @@ "smithy.api#documentation": "

Configuration to control how SageMaker captures inference data for batch transform jobs.

" } }, + "com.amazonaws.sagemaker#BatchDeleteClusterNodeLogicalIdsError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodesErrorCode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The error code associated with the failure. Possible values include NodeLogicalIdNotFound, InvalidNodeStatus, and InternalError.

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sagemaker#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A descriptive message providing additional details about the error.

", + "smithy.api#required": {} + } + }, + "NodeLogicalId": { + "target": "com.amazonaws.sagemaker#ClusterNodeLogicalId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The NodeLogicalId of the node that could not be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an error that occurred when attempting to delete a node identified by its NodeLogicalId.

" + } + }, + "com.amazonaws.sagemaker#BatchDeleteClusterNodeLogicalIdsErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodeLogicalIdsError" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 99 + } + } + }, "com.amazonaws.sagemaker#BatchDeleteClusterNodes": { "type": "operation", "input": { @@ -4874,6 +5227,13 @@ "smithy.api#clientOptional": {}, "smithy.api#documentation": "

A list of node IDs to be deleted from the specified cluster.

  • For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances that are configured as Slurm controller nodes.

  • If you need to delete more than 99 instances, contact Support for assistance.

" } + }, + "NodeLogicalIds": { + "target": "com.amazonaws.sagemaker#ClusterNodeLogicalIdList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A list of NodeLogicalIds identifying the nodes to be deleted. You can specify up to 50 NodeLogicalIds. You must specify either NodeLogicalIds, InstanceIds, or both, with a combined maximum of 50 identifiers.

" + } } }, "traits": { @@ -4894,6 +5254,18 @@ "traits": { "smithy.api#documentation": "

A list of node IDs that were successfully deleted from the specified cluster.

" } + }, + "FailedNodeLogicalIds": { + "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodeLogicalIdsErrorList", + "traits": { + "smithy.api#documentation": "

A list of NodeLogicalIds that could not be deleted, along with error information explaining why the deletion failed.

" + } + }, + "SuccessfulNodeLogicalIds": { + "target": "com.amazonaws.sagemaker#ClusterNodeLogicalIdList", + "traits": { + "smithy.api#documentation": "

A list of NodeLogicalIds that were successfully deleted from the cluster.

" + } } }, "traits": { @@ -5258,7 +5630,7 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 1, + "min": 0, "max": 500 } } @@ -5574,6 +5946,26 @@ "smithy.api#documentation": "

The SageMaker Canvas application settings.

" } }, + "com.amazonaws.sagemaker#CapacityReservation": { + "type": "structure", + "members": { + "Arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Capacity Reservation.

" + } + }, + "Type": { + "target": "com.amazonaws.sagemaker#CapacityReservationType", + "traits": { + "smithy.api#documentation": "

The type of Capacity Reservation. Valid values are ODCR (On-Demand Capacity Reservation) or CRG (Capacity Reservation Group).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Capacity Reservation used by an instance or instance group.

" + } + }, "com.amazonaws.sagemaker#CapacityReservationPreference": { "type": "enum", "members": { @@ -5585,6 +5977,23 @@ } } }, + "com.amazonaws.sagemaker#CapacityReservationType": { + "type": "enum", + "members": { + "ODCR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ODCR" + } + }, + "CRG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CRG" + } + } + } + }, "com.amazonaws.sagemaker#CapacitySize": { "type": "structure", "members": { @@ -7231,8 +7640,7 @@ "target": "com.amazonaws.sagemaker#ClusterEbsVolumeSizeInGB", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

" } } }, @@ -7249,6 +7657,188 @@ } } }, + "com.amazonaws.sagemaker#ClusterEventDetail": { + "type": "structure", + "members": { + "EventId": { + "target": "com.amazonaws.sagemaker#EventId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier (UUID) of the event.

", + "smithy.api#required": {} + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster associated with the event.

", + "smithy.api#required": {} + } + }, + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the SageMaker HyperPod cluster associated with the event.

", + "smithy.api#required": {} + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the instance group associated with the event, if applicable.

" + } + }, + "InstanceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The EC2 instance ID associated with the event, if applicable.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.sagemaker#ClusterEventResourceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of resource associated with the event. Valid values are \"Cluster\", \"InstanceGroup\", or \"Instance\".

", + "smithy.api#required": {} + } + }, + "EventTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The timestamp when the event occurred.

", + "smithy.api#required": {} + } + }, + "EventDetails": { + "target": "com.amazonaws.sagemaker#EventDetails", + "traits": { + "smithy.api#documentation": "

Additional details about the event, including event-specific metadata.

" + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A human-readable description of the event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Detailed information about a specific event in a HyperPod cluster.

" + } + }, + "com.amazonaws.sagemaker#ClusterEventMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ClusterEventResourceType": { + "type": "enum", + "members": { + "CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cluster" + } + }, + "INSTANCE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceGroup" + } + }, + "INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Instance" + } + } + } + }, + "com.amazonaws.sagemaker#ClusterEventSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterEventSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.sagemaker#ClusterEventSummary": { + "type": "structure", + "members": { + "EventId": { + "target": "com.amazonaws.sagemaker#EventId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier (UUID) of the event.

", + "smithy.api#required": {} + } + }, + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster associated with the event.

", + "smithy.api#required": {} + } + }, + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the SageMaker HyperPod cluster associated with the event.

", + "smithy.api#required": {} + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the instance group associated with the event, if applicable.

" + } + }, + "InstanceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The EC2 instance ID associated with the event, if applicable.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.sagemaker#ClusterEventResourceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of resource associated with the event. Valid values are \"Cluster\", \"InstanceGroup\", or \"Instance\".

", + "smithy.api#required": {} + } + }, + "EventTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The timestamp when the event occurred.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A brief, human-readable description of the event.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of an event in a SageMaker HyperPod cluster.

" + } + }, "com.amazonaws.sagemaker#ClusterInstanceCount": { "type": "integer", "traits": { @@ -7344,6 +7934,18 @@ "traits": { "smithy.api#documentation": "

The configuration object of the schedule that SageMaker follows when updating the AMI.

" } + }, + "CurrentImageId": { + "target": "com.amazonaws.sagemaker#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) currently in use by the instance group.

" + } + }, + "DesiredImageId": { + "target": "com.amazonaws.sagemaker#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) desired for the instance group.

" + } } }, "traits": { @@ -7444,6 +8046,12 @@ "traits": { "smithy.api#documentation": "

The configuration object of the schedule that SageMaker uses to update the AMI.

" } + }, + "ImageId": { + "target": "com.amazonaws.sagemaker#ImageId", + "traits": { + "smithy.api#documentation": "

When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

  • HyperPodPublicAmiId: Use a HyperPod public AMI

  • CustomAmiId: Use your custom AMI

  • default: Use the default latest system image

f you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

  • Encryption: The custom AMI must be unencrypted.

  • Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

  • Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input.

" + } } }, "traits": { @@ -7532,6 +8140,12 @@ "traits": { "smithy.api#enumValue": "DeepHealthCheckInProgress" } + }, + "NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotFound" + } } } }, @@ -7579,7 +8193,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 1 + "max": 2 } } }, @@ -8294,6 +8908,32 @@ "smithy.api#pattern": "^[\\S\\s]+$" } }, + "com.amazonaws.sagemaker#ClusterMetadata": { + "type": "structure", + "members": { + "FailureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

An error message describing why the cluster level operation (such as creating, updating, or deleting) failed.

" + } + }, + "EksRoleAccessEntries": { + "target": "com.amazonaws.sagemaker#EksRoleAccessEntries", + "traits": { + "smithy.api#documentation": "

A list of Amazon EKS IAM role ARNs associated with the cluster. This is created by SageMaker HyperPod on your behalf and only applies for EKS-orchestrated clusters.

" + } + }, + "SlrAccessEntry": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Service-Linked Role (SLR) associated with the cluster. This is created by SageMaker HyperPod on your behalf and only applies for EKS-orchestrated clusters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata information about a SageMaker HyperPod cluster showing information about the cluster level operations, such as creating, updating, and deleting.

" + } + }, "com.amazonaws.sagemaker#ClusterName": { "type": "string", "traits": { @@ -8329,6 +8969,12 @@ "smithy.api#documentation": "

The ID of the instance.

" } }, + "NodeLogicalId": { + "target": "com.amazonaws.sagemaker#ClusterNodeLogicalId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId.

" + } + }, "InstanceStatus": { "target": "com.amazonaws.sagemaker#ClusterInstanceStatusDetails", "traits": { @@ -8400,6 +9046,18 @@ "traits": { "smithy.api#documentation": "

The placement details of the SageMaker HyperPod cluster node.

" } + }, + "CurrentImageId": { + "target": "com.amazonaws.sagemaker#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) currently in use by the node.

" + } + }, + "DesiredImageId": { + "target": "com.amazonaws.sagemaker#ImageId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) desired for the node.

" + } } }, "traits": { @@ -8428,6 +9086,39 @@ } } }, + "com.amazonaws.sagemaker#ClusterNodeLogicalId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9]$" + } + }, + "com.amazonaws.sagemaker#ClusterNodeLogicalIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ClusterNodeLogicalId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 99 + } + } + }, + "com.amazonaws.sagemaker#ClusterNodeProvisioningMode": { + "type": "enum", + "members": { + "CONTINUOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Continuous" + } + } + } + }, "com.amazonaws.sagemaker#ClusterNodeRecovery": { "type": "enum", "members": { @@ -8470,6 +9161,13 @@ "smithy.api#required": {} } }, + "NodeLogicalId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A unique identifier for the node that persists throughout its lifecycle, from provisioning request to termination. This identifier can be used to track the node even before it has an assigned InstanceId. This field is only included when IncludeNodeLogicalIds is set to True in the ListClusterNodes request.

" + } + }, "InstanceType": { "target": "com.amazonaws.sagemaker#ClusterInstanceType", "traits": { @@ -9595,9 +10293,7 @@ "Count": { "target": "com.amazonaws.sagemaker#InstanceCount", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The number of instances to add to the instance group of a SageMaker HyperPod cluster.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The number of instances to add to the instance group of a SageMaker HyperPod cluster.

" } } }, @@ -10983,6 +11679,12 @@ "traits": { "smithy.api#documentation": "

The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.

" } + }, + "NodeProvisioningMode": { + "target": "com.amazonaws.sagemaker#ClusterNodeProvisioningMode", + "traits": { + "smithy.api#documentation": "

The mode for provisioning nodes in the cluster. You can specify the following modes:

  • Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.

" + } } }, "traits": { @@ -11670,14 +12372,14 @@ "target": "com.amazonaws.sagemaker#Subnets", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The VPC subnets that the domain uses for communication.

" + "smithy.api#documentation": "

The VPC subnets that the domain uses for communication.

The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.

" } }, "VpcId": { "target": "com.amazonaws.sagemaker#VpcId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

" + "smithy.api#documentation": "

The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.

The field is optional when the AppNetworkAccessType parameter is set to PublicInternetOnly for domains created from Amazon SageMaker Unified Studio.

" } }, "Tags": { @@ -16297,6 +16999,12 @@ "traits": { "smithy.api#documentation": "

Use this parameter to configure a workforce using VPC.

" } + }, + "IpAddressType": { + "target": "com.amazonaws.sagemaker#WorkforceIpAddressType", + "traits": { + "smithy.api#documentation": "

Use this parameter to specify whether you want IPv4 only or dualstack (IPv4 and IPv6) to support your labeling workforce.

" + } } }, "traits": { @@ -16477,6 +17185,12 @@ "traits": { "smithy.api#documentation": "

A custom file system in Amazon FSx for Lustre.

" } + }, + "S3FileSystem": { + "target": "com.amazonaws.sagemaker#S3FileSystem", + "traits": { + "smithy.api#documentation": "

A custom file system in Amazon S3. This is only supported in Amazon SageMaker Unified Studio.

" + } } }, "traits": { @@ -16497,6 +17211,12 @@ "traits": { "smithy.api#documentation": "

The settings for a custom Amazon FSx for Lustre file system.

" } + }, + "S3FileSystemConfig": { + "target": "com.amazonaws.sagemaker#S3FileSystemConfig", + "traits": { + "smithy.api#documentation": "

Configuration settings for a custom Amazon S3 file system.

" + } } }, "traits": { @@ -20723,6 +21443,61 @@ "smithy.api#documentation": "

Retrieves information of a SageMaker HyperPod cluster.

" } }, + "com.amazonaws.sagemaker#DescribeClusterEvent": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DescribeClusterEventRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DescribeClusterEventResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves detailed information about a specific event for a given HyperPod cluster. This functionality is only supported when the NodeProvisioningMode is set to Continuous.

" + } + }, + "com.amazonaws.sagemaker#DescribeClusterEventRequest": { + "type": "structure", + "members": { + "EventId": { + "target": "com.amazonaws.sagemaker#EventId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier (UUID) of the event to describe. This ID can be obtained from the ListClusterEvents operation.

", + "smithy.api#required": {} + } + }, + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeClusterEventResponse": { + "type": "structure", + "members": { + "EventDetails": { + "target": "com.amazonaws.sagemaker#ClusterEventDetail", + "traits": { + "smithy.api#documentation": "

Detailed information about the requested cluster event, including event metadata for various resource types such as Cluster, InstanceGroup, Instance, and their associated attributes.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DescribeClusterNode": { "type": "operation", "input": { @@ -20757,6 +21532,13 @@ "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The ID of the SageMaker HyperPod cluster node.

" } + }, + "NodeLogicalId": { + "target": "com.amazonaws.sagemaker#ClusterNodeLogicalId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The logical identifier of the node to describe. You can specify either NodeLogicalId or InstanceId, but not both. NodeLogicalId can be used to describe nodes that are still being provisioned and don't yet have an InstanceId assigned.

" + } } }, "traits": { @@ -20860,6 +21642,12 @@ "traits": { "smithy.api#documentation": "

The node recovery mode configured for the SageMaker HyperPod cluster.

" } + }, + "NodeProvisioningMode": { + "target": "com.amazonaws.sagemaker#ClusterNodeProvisioningMode", + "traits": { + "smithy.api#documentation": "

The mode used for provisioning nodes in the cluster.

" + } } }, "traits": { @@ -28647,6 +29435,111 @@ "smithy.api#pattern": "^(https|s3)://([^/])/?(.*)$" } }, + "com.amazonaws.sagemaker#DetachClusterNodeVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#DetachClusterNodeVolumeRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#DetachClusterNodeVolumeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches your Amazon Elastic Block Store (Amazon EBS) volume from a node in your EKS-orchestrated SageMaker HyperPod cluster.

This API works with the Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver to manage the lifecycle of persistent storage in your HyperPod EKS clusters.

" + } + }, + "com.amazonaws.sagemaker#DetachClusterNodeVolumeRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster containing the target node. Your cluster must use EKS as the orchestration and be in the InService state.

", + "smithy.api#required": {} + } + }, + "NodeId": { + "target": "com.amazonaws.sagemaker#ClusterNodeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the cluster node from which you want to detach the volume.

", + "smithy.api#required": {} + } + }, + "VolumeId": { + "target": "com.amazonaws.sagemaker#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of your EBS volume that you want to detach. Your volume must be currently attached to the specified node.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DetachClusterNodeVolumeResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume detachment operation was performed.

", + "smithy.api#required": {} + } + }, + "NodeId": { + "target": "com.amazonaws.sagemaker#ClusterNodeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the cluster node from which your volume was detached.

", + "smithy.api#required": {} + } + }, + "VolumeId": { + "target": "com.amazonaws.sagemaker#VolumeId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of your EBS volume that was detached.

", + "smithy.api#required": {} + } + }, + "AttachTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The original timestamp when your volume was initially attached to the node.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#VolumeAttachmentStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of your volume detachment operation.

", + "smithy.api#required": {} + } + }, + "DeviceName": { + "target": "com.amazonaws.sagemaker#VolumeDeviceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The device name assigned to your attached volume on the target instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DetailedAlgorithmStatus": { "type": "enum", "members": { @@ -30435,6 +31328,12 @@ "target": "com.amazonaws.sagemaker#Edge" } }, + "com.amazonaws.sagemaker#EfaEnis": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.sagemaker#EfsUid": { "type": "string", "traits": { @@ -30455,6 +31354,12 @@ "smithy.api#pattern": "^arn:aws[a-z\\-]*:eks:[a-z0-9\\-]*:[0-9]{12}:cluster\\/[0-9A-Za-z][A-Za-z0-9\\-_]{0,99}$" } }, + "com.amazonaws.sagemaker#EksRoleAccessEntries": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.sagemaker#EmrServerlessComputeConfig": { "type": "structure", "members": { @@ -31357,6 +32262,69 @@ "smithy.api#documentation": "

This is an error field object that contains the error code and the reason for an operation failure.

" } }, + "com.amazonaws.sagemaker#EventDetails": { + "type": "structure", + "members": { + "EventMetadata": { + "target": "com.amazonaws.sagemaker#EventMetadata", + "traits": { + "smithy.api#documentation": "

Metadata specific to the event, which may include information about the cluster, instance group, or instance involved.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Detailed information about a specific event, including event metadata.

" + } + }, + "com.amazonaws.sagemaker#EventId": { + "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}$" + } + }, + "com.amazonaws.sagemaker#EventMetadata": { + "type": "union", + "members": { + "Cluster": { + "target": "com.amazonaws.sagemaker#ClusterMetadata", + "traits": { + "smithy.api#documentation": "

Metadata specific to cluster-level events.

" + } + }, + "InstanceGroup": { + "target": "com.amazonaws.sagemaker#InstanceGroupMetadata", + "traits": { + "smithy.api#documentation": "

Metadata specific to instance group-level events.

" + } + }, + "InstanceGroupScaling": { + "target": "com.amazonaws.sagemaker#InstanceGroupScalingMetadata", + "traits": { + "smithy.api#documentation": "

Metadata related to instance group scaling events.

" + } + }, + "Instance": { + "target": "com.amazonaws.sagemaker#InstanceMetadata", + "traits": { + "smithy.api#documentation": "

Metadata specific to instance-level events.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata associated with a cluster event, which may include details about various resource types.

" + } + }, + "com.amazonaws.sagemaker#EventSortBy": { + "type": "enum", + "members": { + "EVENT_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EventTime" + } + } + } + }, "com.amazonaws.sagemaker#ExcludeFeaturesAttribute": { "type": "string", "traits": { @@ -34376,7 +35344,7 @@ "PreHumanTaskLambdaArn": { "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking

3D Point Cloud Modalities

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See 3D Point Cloud Task types to learn more.

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox

Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox

Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation

Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking

3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud frame.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection

3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking

3D point cloud semantic segmentation adjustment - Adjust semantic segmentation masks in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking

3D Point Cloud Modalities

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See 3D Point Cloud Task types to learn more.

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox

Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox

Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation

Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking

3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud frame.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection

3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking

3D point cloud semantic segmentation adjustment - Adjust semantic segmentation masks in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation

Generative AI/Custom - Direct passthrough of input data without any transformation.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-PassThrough

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-PassThrough

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-PassThrough

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-PassThrough

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-PassThrough

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-PassThrough

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-PassThrough

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-PassThrough

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-PassThrough

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-PassThrough

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-PassThrough

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-PassThrough

" } }, "TaskKeywords": { @@ -35914,6 +36882,16 @@ "smithy.api#pattern": "^\\S(.*\\S)?$" } }, + "com.amazonaws.sagemaker#ImageId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 21 + }, + "smithy.api#pattern": "^ami-[0-9a-fA-F]{8,17}|default$" + } + }, "com.amazonaws.sagemaker#ImageName": { "type": "string", "traits": { @@ -36363,6 +37341,9 @@ } } }, + "com.amazonaws.sagemaker#IncludeNodeLogicalIdsBoolean": { + "type": "boolean" + }, "com.amazonaws.sagemaker#InferenceComponentArn": { "type": "string", "traits": { @@ -37557,7 +38538,8 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 1 + "min": 0, + "max": 10000000 } } }, @@ -37593,6 +38575,50 @@ "smithy.api#documentation": "

Defines an instance group for heterogeneous cluster training. When requesting a training job using the CreateTrainingJob API, you can configure multiple instance groups .

" } }, + "com.amazonaws.sagemaker#InstanceGroupMetadata": { + "type": "structure", + "members": { + "FailureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

An error message describing why the instance group level operation (such as creating, scaling, or deleting) failed.

" + } + }, + "AvailabilityZoneId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the Availability Zone where the instance group is located.

" + } + }, + "CapacityReservation": { + "target": "com.amazonaws.sagemaker#CapacityReservation", + "traits": { + "smithy.api#documentation": "

Information about the Capacity Reservation used by the instance group.

" + } + }, + "SubnetId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the subnet where the instance group is located.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

A list of security group IDs associated with the instance group.

" + } + }, + "AmiOverride": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If you use a custom Amazon Machine Image (AMI) for the instance group, this field shows the ID of the custom AMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata information about an instance group in a SageMaker HyperPod cluster.

" + } + }, "com.amazonaws.sagemaker#InstanceGroupName": { "type": "string", "traits": { @@ -37615,6 +38641,32 @@ } } }, + "com.amazonaws.sagemaker#InstanceGroupScalingMetadata": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.sagemaker#InstanceCount", + "traits": { + "smithy.api#documentation": "

The current number of instances in the group.

" + } + }, + "TargetCount": { + "target": "com.amazonaws.sagemaker#TargetCount", + "traits": { + "smithy.api#documentation": "

The desired number of instances for the group after scaling.

" + } + }, + "FailureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

An error message describing why the scaling operation failed, if applicable.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata information about scaling operations for an instance group.

" + } + }, "com.amazonaws.sagemaker#InstanceGroupStatus": { "type": "enum", "members": { @@ -37683,6 +38735,50 @@ } } }, + "com.amazonaws.sagemaker#InstanceMetadata": { + "type": "structure", + "members": { + "CustomerEni": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the customer-managed Elastic Network Interface (ENI) associated with the instance.

" + } + }, + "AdditionalEnis": { + "target": "com.amazonaws.sagemaker#AdditionalEnis", + "traits": { + "smithy.api#documentation": "

Information about additional Elastic Network Interfaces (ENIs) associated with the instance.

" + } + }, + "CapacityReservation": { + "target": "com.amazonaws.sagemaker#CapacityReservation", + "traits": { + "smithy.api#documentation": "

Information about the Capacity Reservation used by the instance.

" + } + }, + "FailureMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

An error message describing why the instance creation or update failed, if applicable.

" + } + }, + "LcsExecutionState": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The execution state of the Lifecycle Script (LCS) for the instance.

" + } + }, + "NodeLogicalId": { + "target": "com.amazonaws.sagemaker#ClusterNodeLogicalId", + "traits": { + "smithy.api#documentation": "

The unique logical identifier of the node within the cluster. The ID used here is the same object as in the BatchAddClusterNodes API.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata information about an instance in a HyperPod cluster.

" + } + }, "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration": { "type": "structure", "members": { @@ -40809,6 +41905,119 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#ListClusterEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#ListClusterEventsRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#ListClusterEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of event summaries for a specified HyperPod cluster. The operation supports filtering, sorting, and pagination of results. This functionality is only supported when the NodeProvisioningMode is set to Continuous.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Events", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListClusterEventsRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.

", + "smithy.api#required": {} + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the instance group to filter events. If specified, only events related to this instance group are returned.

" + } + }, + "NodeId": { + "target": "com.amazonaws.sagemaker#ClusterNodeId", + "traits": { + "smithy.api#documentation": "

The EC2 instance ID to filter events. If specified, only events related to this instance are returned.

" + } + }, + "EventTimeAfter": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time range for filtering events. Only events that occurred after this time are included in the results.

" + } + }, + "EventTimeBefore": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time range for filtering events. Only events that occurred before this time are included in the results.

" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#EventSortBy", + "traits": { + "smithy.api#documentation": "

The field to use for sorting the event list. Currently, the only supported value is EventTime.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.sagemaker#SortOrder", + "traits": { + "smithy.api#documentation": "

The order in which to sort the results. Valid values are Ascending or Descending (the default is Descending).

" + } + }, + "ResourceType": { + "target": "com.amazonaws.sagemaker#ClusterEventResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource for which to filter events. Valid values are Cluster, InstanceGroup, or Instance.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#ClusterEventMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of events to return in the response. Valid range is 1 to 100.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to retrieve the next set of results. This token is obtained from the output of a previous ListClusterEvents call.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#ListClusterEventsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "

A token to retrieve the next set of results. Include this token in subsequent ListClusterEvents calls to fetch more events.

" + } + }, + "Events": { + "target": "com.amazonaws.sagemaker#ClusterEventSummaries", + "traits": { + "smithy.api#documentation": "

A list of event summaries matching the specified criteria.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#ListClusterNodes": { "type": "operation", "input": { @@ -40884,6 +42093,12 @@ "traits": { "smithy.api#documentation": "

The sort order for results. The default value is Ascending.

" } + }, + "IncludeNodeLogicalIds": { + "target": "com.amazonaws.sagemaker#IncludeNodeLogicalIdsBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to include nodes that are still being provisioned in the response. When set to true, the response includes all nodes regardless of their provisioning status. When set to False (default), only nodes with assigned InstanceIds are returned.

" + } } }, "traits": { @@ -52866,6 +54081,41 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.sagemaker#NodeAdditionResult": { + "type": "structure", + "members": { + "NodeLogicalId": { + "target": "com.amazonaws.sagemaker#ClusterNodeLogicalId", + "traits": { + "smithy.api#documentation": "

A unique identifier assigned to the node that can be used to track its provisioning status through the DescribeClusterNode operation.

", + "smithy.api#required": {} + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#ClusterInstanceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the instance group to which the node was added.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#ClusterInstanceStatus", + "traits": { + "smithy.api#documentation": "

The current status of the node. Possible values include Pending, Running, Failed, ShuttingDown, SystemUpdating, DeepHealthCheckInProgress, and NotFound.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a node that was successfully added to the cluster.

" + } + }, + "com.amazonaws.sagemaker#NodeAdditionResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#NodeAdditionResult" + } + }, "com.amazonaws.sagemaker#NodeUnavailabilityType": { "type": "enum", "members": { @@ -62129,6 +63379,12 @@ "traits": { "smithy.api#enumValue": "ml.p6-b200.48xlarge" } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } } } }, @@ -63219,6 +64475,40 @@ } } }, + "com.amazonaws.sagemaker#S3FileSystem": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3SchemaUri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI that specifies the location in S3 where files are stored, which is mounted within the Studio environment. For example: s3://<bucket-name>/<prefix>/.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom file system in Amazon S3. This is only supported in Amazon SageMaker Unified Studio.

" + } + }, + "com.amazonaws.sagemaker#S3FileSystemConfig": { + "type": "structure", + "members": { + "MountPath": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "

The file system path where the Amazon S3 storage location will be mounted within the Amazon SageMaker Studio environment.

" + } + }, + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3SchemaUri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI of the S3 file system configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration for the custom Amazon S3 file system.

" + } + }, "com.amazonaws.sagemaker#S3ModelDataSource": { "type": "structure", "members": { @@ -63332,6 +64622,15 @@ "smithy.api#documentation": "

This object defines the access restrictions to Amazon S3 resources that are included in custom worker task templates using the Liquid filter, grant_read_access.

To learn more about how custom templates are created, see Create custom worker task templates.

" } }, + "com.amazonaws.sagemaker#S3SchemaUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^(s3)://([^/]+)/?(.*)$" + } + }, "com.amazonaws.sagemaker#S3StorageConfig": { "type": "structure", "members": { @@ -63383,6 +64682,12 @@ { "target": "com.amazonaws.sagemaker#AssociateTrialComponent" }, + { + "target": "com.amazonaws.sagemaker#AttachClusterNodeVolume" + }, + { + "target": "com.amazonaws.sagemaker#BatchAddClusterNodes" + }, { "target": "com.amazonaws.sagemaker#BatchDeleteClusterNodes" }, @@ -63779,6 +65084,9 @@ { "target": "com.amazonaws.sagemaker#DescribeCluster" }, + { + "target": "com.amazonaws.sagemaker#DescribeClusterEvent" + }, { "target": "com.amazonaws.sagemaker#DescribeClusterNode" }, @@ -63956,6 +65264,9 @@ { "target": "com.amazonaws.sagemaker#DescribeWorkteam" }, + { + "target": "com.amazonaws.sagemaker#DetachClusterNodeVolume" + }, { "target": "com.amazonaws.sagemaker#DisableSagemakerServicecatalogPortfolio" }, @@ -64013,6 +65324,9 @@ { "target": "com.amazonaws.sagemaker#ListCandidatesForAutoMLJob" }, + { + "target": "com.amazonaws.sagemaker#ListClusterEvents" + }, { "target": "com.amazonaws.sagemaker#ListClusterNodes" }, @@ -69452,6 +70766,14 @@ } } }, + "com.amazonaws.sagemaker#TargetCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.sagemaker#TargetDevice": { "type": "enum", "members": { @@ -74854,7 +76176,7 @@ "SingleSignOnApplicationArn": { "target": "com.amazonaws.sagemaker#SingleSignOnApplicationArn", "traits": { - "smithy.api#documentation": "

The ARN of the application managed by SageMaker AI and SageMaker Unified Studio in the Amazon Web Services IAM Identity Center.

" + "smithy.api#documentation": "

The ARN of the Amazon DataZone application managed by Amazon SageMaker Unified Studio in the Amazon Web Services IAM Identity Center.

" } } }, @@ -75302,6 +76624,12 @@ "traits": { "smithy.api#documentation": "

The configuration to use when updating the AMI versions.

" } + }, + "ImageId": { + "target": "com.amazonaws.sagemaker#ImageId", + "traits": { + "smithy.api#documentation": "

When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

  • HyperPodPublicAmiId: Use a HyperPod public AMI

  • CustomAmiId: Use your custom AMI

  • default: Use the default latest system image

f you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

  • Encryption: The custom AMI must be unencrypted.

  • Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

  • Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input.

" + } } }, "traits": { @@ -78100,7 +79428,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

The worker portal is now supported in VPC and public internet.

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as \"10.0.0.0/16\".

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.

This operation only applies to private workforces.

" + "smithy.api#documentation": "

Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration.

The worker portal is now supported in VPC and public internet.

Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal.

To restrict public internet access for all workers, configure the SourceIpConfig CIDR value. For example, when using SourceIpConfig with an IpAddressType of IPv4, you can restrict access to the IPv4 CIDR block \"10.0.0.0/16\". When using an IpAddressType of dualstack, you can specify both the IPv4 and IPv6 CIDR blocks, such as \"10.0.0.0/16\" for IPv4 only, \"2001:db8:1234:1a00::/56\" for IPv6 only, or \"10.0.0.0/16\" and \"2001:db8:1234:1a00::/56\" for dual stack.

Amazon SageMaker does not support Source Ip restriction for worker portals in VPC.

Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP.

You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam operation.

After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce operation.

This operation only applies to private workforces.

" } }, "com.amazonaws.sagemaker#UpdateWorkforceRequest": { @@ -78131,6 +79459,12 @@ "traits": { "smithy.api#documentation": "

Use this parameter to update your VPC configuration for a workforce.

" } + }, + "IpAddressType": { + "target": "com.amazonaws.sagemaker#WorkforceIpAddressType", + "traits": { + "smithy.api#documentation": "

Use this parameter to specify whether you want IPv4 only or dualstack (IPv4 and IPv6) to support your labeling workforce.

" + } } }, "traits": { @@ -78821,6 +80155,61 @@ "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, + "com.amazonaws.sagemaker#VolumeAttachmentStatus": { + "type": "enum", + "members": { + "ATTACHING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attaching" + } + }, + "ATTACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "attached" + } + }, + "DETACHING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "detaching" + } + }, + "DETACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "detached" + } + }, + "BUSY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "busy" + } + } + } + }, + "com.amazonaws.sagemaker#VolumeDeviceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^/dev/(xvd[a-z]|sd[b-z]|sd[f-p][1-6])$" + } + }, + "com.amazonaws.sagemaker#VolumeId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^vol-[a-f0-9]{8}(?:[a-f0-9]{9})?$" + } + }, "com.amazonaws.sagemaker#VolumeSizeInGB": { "type": "integer", "traits": { @@ -79068,6 +80457,12 @@ "traits": { "smithy.api#documentation": "

The reason your workforce failed.

" } + }, + "IpAddressType": { + "target": "com.amazonaws.sagemaker#WorkforceIpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type you specify - either IPv4 only or dualstack (IPv4 and IPv6) - to support your labeling workforce.

" + } } }, "traits": { @@ -79094,6 +80489,23 @@ "smithy.api#pattern": "^.+$" } }, + "com.amazonaws.sagemaker#WorkforceIpAddressType": { + "type": "enum", + "members": { + "ipv4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "dualstack": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dualstack" + } + } + } + }, "com.amazonaws.sagemaker#WorkforceName": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/securityhub.json b/codegen/sdk/aws-models/securityhub.json index 7fd5512ec94..037d00a0a3c 100644 --- a/codegen/sdk/aws-models/securityhub.json +++ b/codegen/sdk/aws-models/securityhub.json @@ -22680,6 +22680,32 @@ "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) and other details of the Amazon CloudWatch Logs log group that Amazon Route 53 is \npublishing logs to.

" } }, + "com.amazonaws.securityhub#CodeRepositoryDetails": { + "type": "structure", + "members": { + "ProviderType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The type of repository provider.\n

" + } + }, + "ProjectName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The name of the project in the code repository.\n

" + } + }, + "CodeSecurityIntegrationArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the code security integration associated with the repository.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Details about an external code repository with which you can connect your Amazon Web Services resources. \n The connection is established through Amazon Inspector.\n

" + } + }, "com.amazonaws.securityhub#CodeVulnerabilitiesFilePath": { "type": "structure", "members": { @@ -28399,7 +28425,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns the history of a Security Hub finding for the past 90 days. The history includes changes made to any fields in \n the Amazon Web Services Security Finding Format (ASFF) except top-level timestamp fields, such as the CreatedAt and \n UpdatedAt fields.\n

\n

This operation might return fewer results than the maximum number of results (MaxResults) specified in a request, even \n when more results are available. If this occurs, the response includes a NextToken value, which you should use to retrieve \n the next set of results in the response. The presence of a NextToken value in a response doesn't necessarily indicate \n that the results are incomplete. However, you should continue to specify a NextToken value until you receive a \n response that doesn't include this value.

", + "smithy.api#documentation": "

\n Returns the history of a Security Hub finding. The history includes changes made to any fields in \n the Amazon Web Services Security Finding Format (ASFF) except top-level timestamp fields, such as the CreatedAt and \n UpdatedAt fields.\n

\n

This operation might return fewer results than the maximum number of results (MaxResults) specified in a request, even \n when more results are available. If this occurs, the response includes a NextToken value, which you should use to retrieve \n the next set of results in the response. The presence of a NextToken value in a response doesn't necessarily indicate \n that the results are incomplete. However, you should continue to specify a NextToken value until you receive a \n response that doesn't include this value.

", "smithy.api#http": { "method": "POST", "uri": "/findingHistory/get", @@ -28426,13 +28452,13 @@ "StartTime": { "target": "com.amazonaws.securityhub#Timestamp", "traits": { - "smithy.api#documentation": "

A timestamp that indicates the start time of the requested finding history.

\n

If you provide values for both StartTime and EndTime,\n Security Hub returns finding history for the specified time period. If you\n provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at\n which the API is called. If you provide a value for EndTime but not for\n StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you\n provide neither StartTime nor EndTime, Security Hub\n returns finding history from the CreatedAt timestamp of the finding to the time at which\n the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is \n limited to 90 days.

\n

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

" + "smithy.api#documentation": "

A timestamp that indicates the start time of the requested finding history.

\n

If you provide values for both StartTime and EndTime,\n Security Hub returns finding history for the specified time period. If you\n provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at\n which the API is called. If you provide a value for EndTime but not for\n StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you\n provide neither StartTime nor EndTime, Security Hub\n returns finding history from the CreatedAt timestamp of the finding to the time at which\n the API is called. In all of these scenarios, the response is limited to 100 results.

\n

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

" } }, "EndTime": { "target": "com.amazonaws.securityhub#Timestamp", "traits": { - "smithy.api#documentation": "

\n An ISO 8601-formatted timestamp that indicates the end time of the requested finding history.

\n

If you provide values for both StartTime and EndTime,\n Security Hub returns finding history for the specified time period. If you\n provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at\n which the API is called. If you provide a value for EndTime but not for\n StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you\n provide neither StartTime nor EndTime, Security Hub\n returns finding history from the CreatedAt timestamp of the finding to the time at which\n the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is \n limited to 90 days.

\n

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

" + "smithy.api#documentation": "

\n An ISO 8601-formatted timestamp that indicates the end time of the requested finding history.

\n

If you provide values for both StartTime and EndTime,\n Security Hub returns finding history for the specified time period. If you\n provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at\n which the API is called. If you provide a value for EndTime but not for\n StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you\n provide neither StartTime nor EndTime, Security Hub\n returns finding history from the CreatedAt timestamp of the finding to the time at which\n the API is called. In all of these scenarios, the response is limited to 100 results.

\n

For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

" } }, "NextToken": { @@ -34720,6 +34746,12 @@ "traits": { "smithy.api#documentation": "

\n Provides details about an Client VPN endpoint. A Client VPN endpoint is the resource that you \n create and configure to enable and manage client VPN sessions. It's the termination point for all client VPN sessions.\n

" } + }, + "CodeRepository": { + "target": "com.amazonaws.securityhub#CodeRepositoryDetails", + "traits": { + "smithy.api#documentation": "

\n Details about an external code repository with which you can connect your Amazon Web Services resources. \n The connection is established through Amazon Inspector.\n

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/sesv2.json b/codegen/sdk/aws-models/sesv2.json index c7acc65a148..44894d87b21 100644 --- a/codegen/sdk/aws-models/sesv2.json +++ b/codegen/sdk/aws-models/sesv2.json @@ -127,7 +127,12 @@ } }, "com.amazonaws.sesv2#AmazonResourceName": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } }, "com.amazonaws.sesv2#ArchiveArn": { "type": "string", @@ -2138,6 +2143,166 @@ "smithy.api#output": {} } }, + "com.amazonaws.sesv2#CreateTenant": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#CreateTenantRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#CreateTenantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#AlreadyExistsException" + }, + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#LimitExceededException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a tenant.

\n

\n Tenants are logical containers that group related SES resources together.\n Each tenant can have its own set of resources like email identities, configuration sets,\n and templates, along with reputation metrics and sending status. This helps isolate and manage\n email sending for different customers or business units within your Amazon SES API v2 account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/email/tenants", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#CreateTenantRequest": { + "type": "structure", + "members": { + "TenantName": { + "target": "com.amazonaws.sesv2#TenantName", + "traits": { + "smithy.api#documentation": "

The name of the tenant to create. The name can contain up to 64 alphanumeric\n characters, including letters, numbers, hyphens (-) and underscores (_) only.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sesv2#TagList", + "traits": { + "smithy.api#documentation": "

An array of objects that define the tags (keys and values) to associate with the tenant

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to create a tenant.

\n

\n Tenants are logical containers that group related SES resources together.\n Each tenant can have its own set of resources like email identities, configuration sets, and templates,\n along with reputation metrics and sending status. This helps isolate and manage email sending\n for different customers or business units within your Amazon SES API v2 account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#CreateTenantResourceAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#CreateTenantResourceAssociationRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#CreateTenantResourceAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#AlreadyExistsException" + }, + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Associate a resource with a tenant.

\n

\n Resources can be email identities, configuration sets, or email templates.\n When you associate a resource with a tenant, you can use that resource when sending emails\n on behalf of that tenant.

\n

A single resource can be associated with multiple tenants, allowing for resource sharing\n across different tenants while maintaining isolation in email sending operations.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/email/tenants/resources", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#CreateTenantResourceAssociationRequest": { + "type": "structure", + "members": { + "TenantName": { + "target": "com.amazonaws.sesv2#TenantName", + "traits": { + "smithy.api#documentation": "

The name of the tenant to associate the resource with.

", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.sesv2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to associate with the tenant.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to associate a resource with a tenant.

\n

Resources can be email identities, configuration sets, or email templates.\n When you associate a resource with a tenant, you can use that resource when sending\n emails on behalf of that tenant.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#CreateTenantResourceAssociationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sesv2#CreateTenantResponse": { + "type": "structure", + "members": { + "TenantName": { + "target": "com.amazonaws.sesv2#TenantName", + "traits": { + "smithy.api#documentation": "

The name of the tenant.

" + } + }, + "TenantId": { + "target": "com.amazonaws.sesv2#TenantId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the tenant.

" + } + }, + "TenantArn": { + "target": "com.amazonaws.sesv2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the tenant.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the tenant was created.

" + } + }, + "Tags": { + "target": "com.amazonaws.sesv2#TagList", + "traits": { + "smithy.api#documentation": "

An array of objects that define the tags (keys and values) associated with the tenant.

" + } + }, + "SendingStatus": { + "target": "com.amazonaws.sesv2#SendingStatus", + "traits": { + "smithy.api#documentation": "

The status of email sending capability for the tenant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a newly created tenant.

", + "smithy.api#output": {} + } + }, "com.amazonaws.sesv2#CustomRedirectDomain": { "type": "string", "traits": { @@ -2284,14 +2449,14 @@ "WarmupStatus": { "target": "com.amazonaws.sesv2#WarmupStatus", "traits": { - "smithy.api#documentation": "

The warm-up status of a dedicated IP address. The status can have one of the following\n values:

\n
    \n
  • \n

    \n IN_PROGRESS – The IP address isn't ready to use because the\n dedicated IP warm-up process is ongoing.

    \n
    • \n
  • \n

    \n DONE – The dedicated IP warm-up process is complete, and\n the IP address is ready to use.

    \n
    • \n
", + "smithy.api#documentation": "

The warm-up status of a dedicated IP address. The status can have one of the following\n values:

\n
    \n
  • \n

    \n IN_PROGRESS – The IP address isn't ready to use because the\n dedicated IP warm-up process is ongoing.

    \n
    • \n
  • \n

    \n DONE – The dedicated IP warm-up process is complete, and\n the IP address is ready to use.

    \n
    • \n
  • \n

    \n NOT_APPLICABLE – The warm-up status doesn't apply to this IP address.\n This status is used for IP addresses in managed dedicated IP pools, where Amazon SES automatically\n handles the warm-up process.

    \n
    • \n
", "smithy.api#required": {} } }, "WarmupPercentage": { "target": "com.amazonaws.sesv2#Percentage100Wrapper", "traits": { - "smithy.api#documentation": "

Indicates how complete the dedicated IP warm-up process is. When this value equals 1,\n the address has completed the warm-up process and is ready for use.

", + "smithy.api#documentation": "

Indicates the progress of your dedicated IP warm-up:

\n
    \n
  • \n

    \n 0-100 – For standard dedicated IP addresses, this shows the warm-up completion percentage. A value of 100 means the IP address is fully warmed up and ready for use.

    \n
    • \n
  • \n

    \n -1 – Appears for IP addresses in managed dedicated pools where Amazon SES automatically handles the warm-up process, making the percentage not applicable.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -2968,6 +3133,117 @@ "smithy.api#output": {} } }, + "com.amazonaws.sesv2#DeleteTenant": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#DeleteTenantRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#DeleteTenantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete an existing tenant.

\n

When you delete a tenant, its associations with resources\n are removed, but the resources themselves are not deleted.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/email/tenants/delete", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#DeleteTenantRequest": { + "type": "structure", + "members": { + "TenantName": { + "target": "com.amazonaws.sesv2#TenantName", + "traits": { + "smithy.api#documentation": "

The name of the tenant to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to delete a tenant.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#DeleteTenantResourceAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#DeleteTenantResourceAssociationRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#DeleteTenantResourceAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete an association between a tenant and a resource.

\n

When you delete a tenant-resource association, the resource itself is not deleted,\n only its association with the specific tenant is removed. After removal, the resource\n will no longer be available for use with that tenant's email sending operations.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/email/tenants/resources/delete", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#DeleteTenantResourceAssociationRequest": { + "type": "structure", + "members": { + "TenantName": { + "target": "com.amazonaws.sesv2#TenantName", + "traits": { + "smithy.api#documentation": "

The name of the tenant to remove the resource association from.

", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.sesv2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to remove from the tenant association.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to delete an association between a tenant and a resource.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#DeleteTenantResourceAssociationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sesv2#DeleteTenantResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.

", + "smithy.api#output": {} + } + }, "com.amazonaws.sesv2#DeliverabilityDashboardAccountStatus": { "type": "enum", "members": { @@ -6205,13 +6481,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.sesv2#GetSuppressedDestination": { + "com.amazonaws.sesv2#GetReputationEntity": { "type": "operation", "input": { - "target": "com.amazonaws.sesv2#GetSuppressedDestinationRequest" + "target": "com.amazonaws.sesv2#GetReputationEntityRequest" }, "output": { - "target": "com.amazonaws.sesv2#GetSuppressedDestinationResponse" + "target": "com.amazonaws.sesv2#GetReputationEntityResponse" }, "errors": [ { @@ -6225,67 +6501,194 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a specific email address that's on the suppression list\n for your account.

", + "smithy.api#documentation": "

Retrieve information about a specific reputation entity, including its reputation \n management policy, customer-managed status, Amazon Web Services Amazon SES-managed status, and aggregate \n sending status.

\n

\n Reputation entities represent resources in your Amazon SES account that have reputation \n tracking and management capabilities. The reputation impact reflects the highest \n impact reputation finding for the entity. Reputation findings can be retrieved \n using the ListRecommendations operation.

", "smithy.api#http": { "method": "GET", - "uri": "/v2/email/suppression/addresses/{EmailAddress}", + "uri": "/v2/email/reputation/entities/{ReputationEntityType}/{ReputationEntityReference}", "code": 200 } } }, - "com.amazonaws.sesv2#GetSuppressedDestinationRequest": { + "com.amazonaws.sesv2#GetReputationEntityRequest": { "type": "structure", "members": { - "EmailAddress": { - "target": "com.amazonaws.sesv2#EmailAddress", + "ReputationEntityReference": { + "target": "com.amazonaws.sesv2#ReputationEntityReference", "traits": { - "smithy.api#documentation": "

The email address that's on the account suppression list.

", + "smithy.api#documentation": "

The unique identifier for the reputation entity. For resource-type entities, \n this is the Amazon Resource Name (ARN) of the resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "

A request to retrieve information about an email address that's on the suppression\n list for your account.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.sesv2#GetSuppressedDestinationResponse": { - "type": "structure", - "members": { - "SuppressedDestination": { - "target": "com.amazonaws.sesv2#SuppressedDestination", + }, + "ReputationEntityType": { + "target": "com.amazonaws.sesv2#ReputationEntityType", "traits": { - "smithy.api#documentation": "

An object containing information about the suppressed email address.

", + "smithy.api#documentation": "

The type of reputation entity. Currently, only RESOURCE type entities are supported.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Information about the suppressed email address.

", - "smithy.api#output": {} + "smithy.api#documentation": "

Represents a request to retrieve information about a specific reputation entity.

", + "smithy.api#input": {} } }, - "com.amazonaws.sesv2#GuardianAttributes": { + "com.amazonaws.sesv2#GetReputationEntityResponse": { "type": "structure", "members": { - "OptimizedSharedDelivery": { - "target": "com.amazonaws.sesv2#FeatureStatus", + "ReputationEntity": { + "target": "com.amazonaws.sesv2#ReputationEntity", "traits": { - "smithy.api#documentation": "

Specifies the status of your VDM optimized shared delivery. Can be one of the\n following:

\n
    \n
  • \n

    \n ENABLED – Amazon SES enables optimized shared delivery for your\n account.

    \n
    • \n
  • \n

    \n DISABLED – Amazon SES disables optimized shared delivery for\n your account.

    \n
    • \n
" + "smithy.api#documentation": "

The reputation entity information, including status records, policy configuration, \n and reputation impact.

" } } }, "traits": { - "smithy.api#documentation": "

An object containing additional settings for your VDM configuration as applicable to\n the Guardian.

" + "smithy.api#documentation": "

Information about the requested reputation entity.

", + "smithy.api#output": {} } }, - "com.amazonaws.sesv2#GuardianOptions": { - "type": "structure", - "members": { - "OptimizedSharedDelivery": { - "target": "com.amazonaws.sesv2#FeatureStatus", - "traits": { + "com.amazonaws.sesv2#GetSuppressedDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#GetSuppressedDestinationRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#GetSuppressedDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a specific email address that's on the suppression list\n for your account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/email/suppression/addresses/{EmailAddress}", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#GetSuppressedDestinationRequest": { + "type": "structure", + "members": { + "EmailAddress": { + "target": "com.amazonaws.sesv2#EmailAddress", + "traits": { + "smithy.api#documentation": "

The email address that's on the account suppression list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to retrieve information about an email address that's on the suppression\n list for your account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#GetSuppressedDestinationResponse": { + "type": "structure", + "members": { + "SuppressedDestination": { + "target": "com.amazonaws.sesv2#SuppressedDestination", + "traits": { + "smithy.api#documentation": "

An object containing information about the suppressed email address.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the suppressed email address.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sesv2#GetTenant": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#GetTenantRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#GetTenantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Get information about a specific tenant, including the tenant's name, ID, ARN,\n creation timestamp, tags, and sending status.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/email/tenants/get", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#GetTenantRequest": { + "type": "structure", + "members": { + "TenantName": { + "target": "com.amazonaws.sesv2#TenantName", + "traits": { + "smithy.api#documentation": "

The name of the tenant to retrieve information about.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to get information about a specific tenant.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#GetTenantResponse": { + "type": "structure", + "members": { + "Tenant": { + "target": "com.amazonaws.sesv2#Tenant", + "traits": { + "smithy.api#documentation": "

A structure that contains details about the tenant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a specific tenant.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sesv2#GuardianAttributes": { + "type": "structure", + "members": { + "OptimizedSharedDelivery": { + "target": "com.amazonaws.sesv2#FeatureStatus", + "traits": { + "smithy.api#documentation": "

Specifies the status of your VDM optimized shared delivery. Can be one of the\n following:

\n
    \n
  • \n

    \n ENABLED – Amazon SES enables optimized shared delivery for your\n account.

    \n
    • \n
  • \n

    \n DISABLED – Amazon SES disables optimized shared delivery for\n your account.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object containing additional settings for your VDM configuration as applicable to\n the Guardian.

" + } + }, + "com.amazonaws.sesv2#GuardianOptions": { + "type": "structure", + "members": { + "OptimizedSharedDelivery": { + "target": "com.amazonaws.sesv2#FeatureStatus", + "traits": { "smithy.api#documentation": "

Specifies the status of your VDM optimized shared delivery. Can be one of the\n following:

\n
    \n
  • \n

    \n ENABLED – Amazon SES enables optimized shared delivery for the\n configuration set.

    \n
    • \n
  • \n

    \n DISABLED – Amazon SES disables optimized shared delivery for the\n configuration set.

    \n
    • \n
" } } @@ -7911,6 +8314,168 @@ "smithy.api#output": {} } }, + "com.amazonaws.sesv2#ListReputationEntities": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#ListReputationEntitiesRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#ListReputationEntitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

List reputation entities in your Amazon SES account in the current Amazon Web Services Region. \n You can filter the results by entity type, reputation impact, sending status, \n or entity reference prefix.

\n

\n Reputation entities represent resources in your account that have reputation \n tracking and management capabilities. Use this operation to get an overview of \n all entities and their current reputation status.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/email/reputation/entities", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ReputationEntities", + "pageSize": "PageSize" + } + } + }, + "com.amazonaws.sesv2#ListReputationEntitiesRequest": { + "type": "structure", + "members": { + "Filter": { + "target": "com.amazonaws.sesv2#ReputationEntityFilter", + "traits": { + "smithy.api#documentation": "

An object that contains filters to apply when listing reputation entities. \n You can filter by entity type, reputation impact, sending status, or entity \n reference prefix.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sesv2#NextToken", + "traits": { + "smithy.api#documentation": "

A token returned from a previous call to ListReputationEntities to indicate \n the position in the list of reputation entities.

" + } + }, + "PageSize": { + "target": "com.amazonaws.sesv2#MaxItems", + "traits": { + "smithy.api#documentation": "

The number of results to show in a single call to ListReputationEntities. \n If the number of results is larger than the number you specified in this parameter, \n then the response includes a NextToken element, which you can use to obtain \n additional results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to list reputation entities with optional filtering.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#ListReputationEntitiesResponse": { + "type": "structure", + "members": { + "ReputationEntities": { + "target": "com.amazonaws.sesv2#ReputationEntitiesList", + "traits": { + "smithy.api#documentation": "

An array that contains information about the reputation entities in your account.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sesv2#NextToken", + "traits": { + "smithy.api#documentation": "

A token that indicates that there are additional reputation entities to list. \n To view additional reputation entities, issue another request to ListReputationEntities, \n and pass this token in the NextToken parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of reputation entities in your account.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sesv2#ListResourceTenants": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#ListResourceTenantsRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#ListResourceTenantsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

List all tenants associated with a specific resource.

\n

This operation returns a list of tenants that are associated with the specified\n resource. This is useful for understanding which tenants are currently using a particular\n resource such as an email identity, configuration set, or email template.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/email/resources/tenants/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ResourceTenants", + "pageSize": "PageSize" + } + } + }, + "com.amazonaws.sesv2#ListResourceTenantsRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sesv2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to list associated tenants for.

", + "smithy.api#required": {} + } + }, + "PageSize": { + "target": "com.amazonaws.sesv2#MaxItems", + "traits": { + "smithy.api#documentation": "

The number of results to show in a single call to ListResourceTenants.\n If the number of results is larger than the number you specified in this parameter,\n then the response includes a NextToken element, which you can use to obtain additional results.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sesv2#NextToken", + "traits": { + "smithy.api#documentation": "

A token returned from a previous call to ListResourceTenants to indicate the position in the list of resource tenants.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to list tenants associated with a specific resource.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#ListResourceTenantsResponse": { + "type": "structure", + "members": { + "ResourceTenants": { + "target": "com.amazonaws.sesv2#ResourceTenantMetadataList", + "traits": { + "smithy.api#documentation": "

An array that contains information about each tenant associated with the resource.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sesv2#NextToken", + "traits": { + "smithy.api#documentation": "

A token that indicates that there are additional tenants to list. To view additional tenants,\n issue another request to ListResourceTenants, and pass this token in the NextToken parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about tenants associated with a specific resource.

", + "smithy.api#output": {} + } + }, "com.amazonaws.sesv2#ListSuppressedDestinations": { "type": "operation", "input": { @@ -7944,127 +8509,325 @@ } } }, - "com.amazonaws.sesv2#ListSuppressedDestinationsRequest": { + "com.amazonaws.sesv2#ListSuppressedDestinationsRequest": { + "type": "structure", + "members": { + "Reasons": { + "target": "com.amazonaws.sesv2#SuppressionListReasons", + "traits": { + "smithy.api#documentation": "

The factors that caused the email address to be added to .

", + "smithy.api#httpQuery": "Reason" + } + }, + "StartDate": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "

Used to filter the list of suppressed email destinations so that it only includes\n addresses that were added to the list after a specific date.

", + "smithy.api#httpQuery": "StartDate" + } + }, + "EndDate": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "

Used to filter the list of suppressed email destinations so that it only includes\n addresses that were added to the list before a specific date.

", + "smithy.api#httpQuery": "EndDate" + } + }, + "NextToken": { + "target": "com.amazonaws.sesv2#NextToken", + "traits": { + "smithy.api#documentation": "

A token returned from a previous call to ListSuppressedDestinations to\n indicate the position in the list of suppressed email addresses.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "PageSize": { + "target": "com.amazonaws.sesv2#MaxItems", + "traits": { + "smithy.api#documentation": "

The number of results to show in a single call to\n ListSuppressedDestinations. If the number of results is larger than the\n number you specified in this parameter, then the response includes a\n NextToken element, which you can use to obtain additional\n results.

", + "smithy.api#httpQuery": "PageSize" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to obtain a list of email destinations that are on the suppression list for\n your account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#ListSuppressedDestinationsResponse": { + "type": "structure", + "members": { + "SuppressedDestinationSummaries": { + "target": "com.amazonaws.sesv2#SuppressedDestinationSummaries", + "traits": { + "smithy.api#documentation": "

A list of summaries, each containing a summary for a suppressed email\n destination.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sesv2#NextToken", + "traits": { + "smithy.api#documentation": "

A token that indicates that there are additional email addresses on the suppression\n list for your account. To view additional suppressed addresses, issue another request to\n ListSuppressedDestinations, and pass this token in the\n NextToken parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of suppressed email addresses.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sesv2#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieve a list of the tags (keys and values) that are associated with a specified\n resource. A tag is a label that you optionally define and associate\n with a resource. Each tag consists of a required tag key and an\n optional associated tag value. A tag key is a general label that\n acts as a category for more specific tag values. A tag value acts as a descriptor within\n a tag key.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/email/tags", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.sesv2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to retrieve tag\n information for.

", + "smithy.api#httpQuery": "ResourceArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.sesv2#TagList", + "traits": { + "smithy.api#documentation": "

An array that lists all the tags that are associated with the resource. Each tag\n consists of a required tag key (Key) and an associated tag value\n (Value)

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sesv2#ListTenantResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#ListTenantResourcesRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#ListTenantResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

List all resources associated with a specific tenant.

\n

This operation returns a list of resources (email identities, configuration sets,\n or email templates) that are associated with the specified tenant. You can optionally\n filter the results by resource type.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/email/tenants/resources/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TenantResources", + "pageSize": "PageSize" + } + } + }, + "com.amazonaws.sesv2#ListTenantResourcesFilter": { + "type": "map", + "key": { + "target": "com.amazonaws.sesv2#ListTenantResourcesFilterKey" + }, + "value": { + "target": "com.amazonaws.sesv2#ListTenantResourcesFilterValue" + }, + "traits": { + "smithy.api#documentation": "

An object that contains mapping between ListTenantResourcesFilterKey\n and ListTenantResourcesFilterValue to filter by.

" + } + }, + "com.amazonaws.sesv2#ListTenantResourcesFilterKey": { + "type": "enum", + "members": { + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_TYPE" + } + } + }, + "traits": { + "smithy.api#documentation": "

The key used to filter tenant resources. Currently, the only supported filter key is RESOURCE_TYPE.

" + } + }, + "com.amazonaws.sesv2#ListTenantResourcesFilterValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The value used to filter tenant resources. When filtering by RESOURCE_TYPE,\n valid values are EMAIL_IDENTITY, CONFIGURATION_SET, or EMAIL_TEMPLATE.

", + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.sesv2#ListTenantResourcesRequest": { "type": "structure", "members": { - "Reasons": { - "target": "com.amazonaws.sesv2#SuppressionListReasons", + "TenantName": { + "target": "com.amazonaws.sesv2#TenantName", "traits": { - "smithy.api#documentation": "

The factors that caused the email address to be added to .

", - "smithy.api#httpQuery": "Reason" + "smithy.api#documentation": "

The name of the tenant to list resources for.

", + "smithy.api#required": {} } }, - "StartDate": { - "target": "com.amazonaws.sesv2#Timestamp", + "Filter": { + "target": "com.amazonaws.sesv2#ListTenantResourcesFilter", "traits": { - "smithy.api#documentation": "

Used to filter the list of suppressed email destinations so that it only includes\n addresses that were added to the list after a specific date.

", - "smithy.api#httpQuery": "StartDate" + "smithy.api#documentation": "

A map of filter keys and values for filtering the list of tenant resources. Currently,\n the only supported filter key is RESOURCE_TYPE.

" } }, - "EndDate": { - "target": "com.amazonaws.sesv2#Timestamp", + "PageSize": { + "target": "com.amazonaws.sesv2#MaxItems", "traits": { - "smithy.api#documentation": "

Used to filter the list of suppressed email destinations so that it only includes\n addresses that were added to the list before a specific date.

", - "smithy.api#httpQuery": "EndDate" + "smithy.api#documentation": "

The number of results to show in a single call to ListTenantResources.\n If the number of results is larger than the number you specified in this parameter,\n then the response includes a NextToken element, which you can use to obtain additional results.

" } }, "NextToken": { "target": "com.amazonaws.sesv2#NextToken", "traits": { - "smithy.api#documentation": "

A token returned from a previous call to ListSuppressedDestinations to\n indicate the position in the list of suppressed email addresses.

", - "smithy.api#httpQuery": "NextToken" - } - }, - "PageSize": { - "target": "com.amazonaws.sesv2#MaxItems", - "traits": { - "smithy.api#documentation": "

The number of results to show in a single call to\n ListSuppressedDestinations. If the number of results is larger than the\n number you specified in this parameter, then the response includes a\n NextToken element, which you can use to obtain additional\n results.

", - "smithy.api#httpQuery": "PageSize" + "smithy.api#documentation": "

A token returned from a previous call to ListTenantResources to indicate the position in the list of tenant resources.

" } } }, "traits": { - "smithy.api#documentation": "

A request to obtain a list of email destinations that are on the suppression list for\n your account.

", + "smithy.api#documentation": "

Represents a request to list resources associated with a specific tenant.

", "smithy.api#input": {} } }, - "com.amazonaws.sesv2#ListSuppressedDestinationsResponse": { + "com.amazonaws.sesv2#ListTenantResourcesResponse": { "type": "structure", "members": { - "SuppressedDestinationSummaries": { - "target": "com.amazonaws.sesv2#SuppressedDestinationSummaries", + "TenantResources": { + "target": "com.amazonaws.sesv2#TenantResourceList", "traits": { - "smithy.api#documentation": "

A list of summaries, each containing a summary for a suppressed email\n destination.

" + "smithy.api#documentation": "

An array that contains information about each resource associated with the tenant.

" } }, "NextToken": { "target": "com.amazonaws.sesv2#NextToken", "traits": { - "smithy.api#documentation": "

A token that indicates that there are additional email addresses on the suppression\n list for your account. To view additional suppressed addresses, issue another request to\n ListSuppressedDestinations, and pass this token in the\n NextToken parameter.

" + "smithy.api#documentation": "

A token that indicates that there are additional resources to list. To view additional resources,\n issue another request to ListTenantResources, and pass this token in the NextToken parameter.

" } } }, "traits": { - "smithy.api#documentation": "

A list of suppressed email addresses.

", + "smithy.api#documentation": "

Information about resources associated with a specific tenant.

", "smithy.api#output": {} } }, - "com.amazonaws.sesv2#ListTagsForResource": { + "com.amazonaws.sesv2#ListTenants": { "type": "operation", "input": { - "target": "com.amazonaws.sesv2#ListTagsForResourceRequest" + "target": "com.amazonaws.sesv2#ListTenantsRequest" }, "output": { - "target": "com.amazonaws.sesv2#ListTagsForResourceResponse" + "target": "com.amazonaws.sesv2#ListTenantsResponse" }, "errors": [ { "target": "com.amazonaws.sesv2#BadRequestException" }, - { - "target": "com.amazonaws.sesv2#NotFoundException" - }, { "target": "com.amazonaws.sesv2#TooManyRequestsException" } ], "traits": { - "smithy.api#documentation": "

Retrieve a list of the tags (keys and values) that are associated with a specified\n resource. A tag is a label that you optionally define and associate\n with a resource. Each tag consists of a required tag key and an\n optional associated tag value. A tag key is a general label that\n acts as a category for more specific tag values. A tag value acts as a descriptor within\n a tag key.

", + "smithy.api#documentation": "

List all tenants associated with your account in the current Amazon Web Services Region.

\n

This operation returns basic information about each tenant,\n such as tenant name, ID, ARN, and creation timestamp.

", "smithy.api#http": { - "method": "GET", - "uri": "/v2/email/tags", + "method": "POST", + "uri": "/v2/email/tenants/list", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Tenants", + "pageSize": "PageSize" } } }, - "com.amazonaws.sesv2#ListTagsForResourceRequest": { + "com.amazonaws.sesv2#ListTenantsRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.sesv2#AmazonResourceName", + "NextToken": { + "target": "com.amazonaws.sesv2#NextToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to retrieve tag\n information for.

", - "smithy.api#httpQuery": "ResourceArn", - "smithy.api#required": {} + "smithy.api#documentation": "

A token returned from a previous call to ListTenants to indicate the position in the list of tenants.

" + } + }, + "PageSize": { + "target": "com.amazonaws.sesv2#MaxItems", + "traits": { + "smithy.api#documentation": "

The number of results to show in a single call to ListTenants.\n If the number of results is larger than the number you specified in this parameter,\n then the response includes a NextToken element, which you can use to obtain additional results.

" } } }, "traits": { + "smithy.api#documentation": "

Represents a request to list all tenants associated with your account in the current Amazon Web Services Region.

", "smithy.api#input": {} } }, - "com.amazonaws.sesv2#ListTagsForResourceResponse": { + "com.amazonaws.sesv2#ListTenantsResponse": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.sesv2#TagList", + "Tenants": { + "target": "com.amazonaws.sesv2#TenantInfoList", "traits": { - "smithy.api#documentation": "

An array that lists all the tags that are associated with the resource. Each tag\n consists of a required tag key (Key) and an associated tag value\n (Value)

", - "smithy.api#required": {} + "smithy.api#documentation": "

An array that contains basic information about each tenant.

" + } + }, + "NextToken": { + "target": "com.amazonaws.sesv2#NextToken", + "traits": { + "smithy.api#documentation": "

A token that indicates that there are additional tenants to list. To view additional tenants,\n issue another request to ListTenants, and pass this token in the NextToken parameter.

" } } }, "traits": { + "smithy.api#documentation": "

Information about tenants associated with your account.

", "smithy.api#output": {} } }, @@ -10447,6 +11210,24 @@ "traits": { "smithy.api#enumValue": "COMPLAINT" } + }, + "BOUNCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOUNCE" + } + }, + "FEEDBACK_3P": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FEEDBACK_3P" + } + }, + "IP_LISTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_LISTING" + } } } }, @@ -10514,6 +11295,142 @@ "smithy.api#documentation": "

A name that helps you identify a report generated by the Deliverability dashboard.

" } }, + "com.amazonaws.sesv2#ReputationEntitiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#ReputationEntity" + }, + "traits": { + "smithy.api#documentation": "

A list of reputation entities.

" + } + }, + "com.amazonaws.sesv2#ReputationEntity": { + "type": "structure", + "members": { + "ReputationEntityReference": { + "target": "com.amazonaws.sesv2#ReputationEntityReference", + "traits": { + "smithy.api#documentation": "

The unique identifier for the reputation entity. For resource-type entities, \n this is the Amazon Resource Name (ARN) of the resource.

" + } + }, + "ReputationEntityType": { + "target": "com.amazonaws.sesv2#ReputationEntityType", + "traits": { + "smithy.api#documentation": "

The type of reputation entity. Currently, only RESOURCE type entities are supported.

" + } + }, + "ReputationManagementPolicy": { + "target": "com.amazonaws.sesv2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the reputation management policy applied to \n this entity. This is an Amazon Web Services Amazon SES-managed policy.

" + } + }, + "CustomerManagedStatus": { + "target": "com.amazonaws.sesv2#StatusRecord", + "traits": { + "smithy.api#documentation": "

The customer-managed status record for this reputation entity, including the \n current status, cause description, and last updated timestamp.

" + } + }, + "AwsSesManagedStatus": { + "target": "com.amazonaws.sesv2#StatusRecord", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Amazon SES-managed status record for this reputation entity, including the \n current status, cause description, and last updated timestamp.

" + } + }, + "SendingStatusAggregate": { + "target": "com.amazonaws.sesv2#SendingStatus", + "traits": { + "smithy.api#documentation": "

The aggregate sending status that determines whether the entity is allowed to\n send emails. This status is derived from both the customer-managed and Amazon Web Services Amazon SES-managed\n statuses. If either the customer-managed status or the Amazon Web Services Amazon SES-managed status is\n DISABLED, the aggregate status will be DISABLED and the entity\n will not be allowed to send emails. When the customer-managed status is set to\n REINSTATED, the entity can continue sending even if there are active\n reputation findings, provided the Amazon Web Services Amazon SES-managed status also permits sending.\n The entity can only send emails when both statuses permit sending.

" + } + }, + "ReputationImpact": { + "target": "com.amazonaws.sesv2#RecommendationImpact", + "traits": { + "smithy.api#documentation": "

The reputation impact level for this entity, representing the highest impact \n reputation finding currently active. Reputation findings can be retrieved using \n the ListRecommendations operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains information about a reputation entity, including its \n reference, type, policy, status records, and reputation impact.

" + } + }, + "com.amazonaws.sesv2#ReputationEntityFilter": { + "type": "map", + "key": { + "target": "com.amazonaws.sesv2#ReputationEntityFilterKey" + }, + "value": { + "target": "com.amazonaws.sesv2#ReputationEntityFilterValue" + }, + "traits": { + "smithy.api#documentation": "

An object that contains filters to apply when listing reputation entities.

" + } + }, + "com.amazonaws.sesv2#ReputationEntityFilterKey": { + "type": "enum", + "members": { + "ENTITY_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTITY_TYPE" + } + }, + "REPUTATION_IMPACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPUTATION_IMPACT" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SENDING_STATUS" + } + }, + "ENTITY_REFERENCE_PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTITY_REFERENCE_PREFIX" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter key to use when listing reputation entities. This can be one of the following:

\n
    \n
  • \n

    \n ENTITY_TYPE – Filter by entity type.

    \n
    • \n
  • \n

    \n REPUTATION_IMPACT – Filter by reputation impact level.

    \n
    • \n
  • \n

    \n SENDING_STATUS – Filter by aggregate sending status.

    \n
    • \n
  • \n

    \n ENTITY_REFERENCE_PREFIX – Filter by entity reference prefix.

    \n
    • \n
" + } + }, + "com.amazonaws.sesv2#ReputationEntityFilterValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The filter value to match against the specified filter key.

", + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.sesv2#ReputationEntityReference": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The unique identifier for a reputation entity. For resource-type entities, \n this is the Amazon Resource Name (ARN) of the resource.

", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sesv2#ReputationEntityType": { + "type": "enum", + "members": { + "RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE" + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of reputation entity. Currently, only RESOURCE type entities are supported, \n which represent resources in your Amazon SES account that have reputation tracking capabilities.

" + } + }, "com.amazonaws.sesv2#ReputationOptions": { "type": "structure", "members": { @@ -10535,6 +11452,73 @@ "smithy.api#documentation": "

Enable or disable collection of reputation metrics for emails that you send using this\n configuration set in the current Amazon Web Services Region.

" } }, + "com.amazonaws.sesv2#ResourceTenantMetadata": { + "type": "structure", + "members": { + "TenantName": { + "target": "com.amazonaws.sesv2#TenantName", + "traits": { + "smithy.api#documentation": "

The name of the tenant associated with the resource.

" + } + }, + "TenantId": { + "target": "com.amazonaws.sesv2#TenantId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the tenant associated with the resource.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.sesv2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "AssociatedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the resource was associated with the tenant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information about a tenant associated with a resource.

" + } + }, + "com.amazonaws.sesv2#ResourceTenantMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#ResourceTenantMetadata" + }, + "traits": { + "smithy.api#documentation": "

A list of tenant metadata objects associated with a resource.

" + } + }, + "com.amazonaws.sesv2#ResourceType": { + "type": "enum", + "members": { + "EMAIL_IDENTITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL_IDENTITY" + } + }, + "CONFIGURATION_SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFIGURATION_SET" + } + }, + "EMAIL_TEMPLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL_TEMPLATE" + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of resource that can be associated with a tenant. Can be one of the following:

\n
    \n
  • \n

    \n EMAIL_IDENTITY - An email address or domain that you use to send email.

    \n
    • \n
  • \n

    \n CONFIGURATION_SET - A set of rules that you can apply to emails you send.

    \n
    • \n
  • \n

    \n EMAIL_TEMPLATE - A template that defines the content of an email message.

    \n
    • \n
" + } + }, "com.amazonaws.sesv2#ReviewDetails": { "type": "structure", "members": { @@ -10803,6 +11787,12 @@ "name": "EndpointId" } } + }, + "TenantName": { + "target": "com.amazonaws.sesv2#TenantName", + "traits": { + "smithy.api#documentation": "

The name of the tenant through which this bulk email will be sent.

\n \n

\n The email sending operation will only succeed if all referenced resources\n (identities, configuration sets, and templates) are associated with this tenant.\n

\n " + } } }, "traits": { @@ -11020,6 +12010,12 @@ } } }, + "TenantName": { + "target": "com.amazonaws.sesv2#TenantName", + "traits": { + "smithy.api#documentation": "

The name of the tenant through which this email will be sent.

\n \n

The email sending operation will only succeed if all referenced resources\n (identities, configuration sets, and templates) are associated with this tenant.\n

\n " + } + }, "ListManagementOptions": { "target": "com.amazonaws.sesv2#ListManagementOptions", "traits": { @@ -11099,15 +12095,41 @@ } }, "traits": { - "smithy.api#documentation": "

The message can't be sent because the account's ability to send email is currently\n paused.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.sesv2#SendingPoolName": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The name of the dedicated IP pool to associate with the configuration set.

" + "smithy.api#documentation": "

The message can't be sent because the account's ability to send email is currently\n paused.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sesv2#SendingPoolName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the dedicated IP pool to associate with the configuration set.

" + } + }, + "com.amazonaws.sesv2#SendingStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "REINSTATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REINSTATED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sending status for a reputation entity. This can be one of the following:

\n
    \n
  • \n

    \n ENABLED – Sending is allowed for this entity.

    \n
    • \n
  • \n

    \n DISABLED – Sending is prevented for this entity.

    \n
    • \n
  • \n

    \n REINSTATED – Sending is allowed even if there are active reputation findings.

    \n
    • \n
" } }, "com.amazonaws.sesv2#SentLast24Hours": { @@ -11171,6 +12193,12 @@ { "target": "com.amazonaws.sesv2#CreateMultiRegionEndpoint" }, + { + "target": "com.amazonaws.sesv2#CreateTenant" + }, + { + "target": "com.amazonaws.sesv2#CreateTenantResourceAssociation" + }, { "target": "com.amazonaws.sesv2#DeleteConfigurationSet" }, @@ -11204,6 +12232,12 @@ { "target": "com.amazonaws.sesv2#DeleteSuppressedDestination" }, + { + "target": "com.amazonaws.sesv2#DeleteTenant" + }, + { + "target": "com.amazonaws.sesv2#DeleteTenantResourceAssociation" + }, { "target": "com.amazonaws.sesv2#GetAccount" }, @@ -11267,9 +12301,15 @@ { "target": "com.amazonaws.sesv2#GetMultiRegionEndpoint" }, + { + "target": "com.amazonaws.sesv2#GetReputationEntity" + }, { "target": "com.amazonaws.sesv2#GetSuppressedDestination" }, + { + "target": "com.amazonaws.sesv2#GetTenant" + }, { "target": "com.amazonaws.sesv2#ListConfigurationSets" }, @@ -11309,12 +12349,24 @@ { "target": "com.amazonaws.sesv2#ListRecommendations" }, + { + "target": "com.amazonaws.sesv2#ListReputationEntities" + }, + { + "target": "com.amazonaws.sesv2#ListResourceTenants" + }, { "target": "com.amazonaws.sesv2#ListSuppressedDestinations" }, { "target": "com.amazonaws.sesv2#ListTagsForResource" }, + { + "target": "com.amazonaws.sesv2#ListTenantResources" + }, + { + "target": "com.amazonaws.sesv2#ListTenants" + }, { "target": "com.amazonaws.sesv2#PutAccountDedicatedIpWarmupAttributes" }, @@ -11416,6 +12468,12 @@ }, { "target": "com.amazonaws.sesv2#UpdateEmailTemplate" + }, + { + "target": "com.amazonaws.sesv2#UpdateReputationEntityCustomerManagedStatus" + }, + { + "target": "com.amazonaws.sesv2#UpdateReputationEntityPolicy" } ], "traits": { @@ -12742,6 +13800,42 @@ "smithy.api#documentation": "

The status of the multi-region endpoint (global-endpoint).

\n
    \n
  • \n

    \n CREATING – The resource is being provisioned.

    \n
    • \n
  • \n

    \n READY – The resource is ready to use.

    \n
    • \n
  • \n

    \n FAILED – The resource failed to be provisioned.

    \n
    • \n
  • \n

    \n DELETING – The resource is being deleted as requested.

    \n
    • \n
" } }, + "com.amazonaws.sesv2#StatusCause": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A description of the reason for a status change, such as automated actions \n taken due to reputation findings or manual status updates.

", + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.sesv2#StatusRecord": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sesv2#SendingStatus", + "traits": { + "smithy.api#documentation": "

The current sending status. This can be one of the following:

\n
    \n
  • \n

    \n ENABLED – Sending is allowed.

    \n
    • \n
  • \n

    \n DISABLED – Sending is prevented.

    \n
    • \n
  • \n

    \n REINSTATED – Sending is allowed even with active reputation findings.

    \n
    • \n
" + } + }, + "Cause": { + "target": "com.amazonaws.sesv2#StatusCause", + "traits": { + "smithy.api#documentation": "

A description of the reason for the current status, or null if no specific \n cause is available.

" + } + }, + "LastUpdatedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when this status was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains status information for a reputation entity, including \n the current status, cause description, and timestamp.

" + } + }, "com.amazonaws.sesv2#Subject": { "type": "string" }, @@ -13097,6 +14191,132 @@ "smithy.api#documentation": "

The content of the custom verification email template.

" } }, + "com.amazonaws.sesv2#Tenant": { + "type": "structure", + "members": { + "TenantName": { + "target": "com.amazonaws.sesv2#TenantName", + "traits": { + "smithy.api#documentation": "

The name of the tenant.

" + } + }, + "TenantId": { + "target": "com.amazonaws.sesv2#TenantId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the tenant.

" + } + }, + "TenantArn": { + "target": "com.amazonaws.sesv2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the tenant.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the tenant was created.

" + } + }, + "Tags": { + "target": "com.amazonaws.sesv2#TagList", + "traits": { + "smithy.api#documentation": "

An array of objects that define the tags (keys and values) associated with the tenant.

" + } + }, + "SendingStatus": { + "target": "com.amazonaws.sesv2#SendingStatus", + "traits": { + "smithy.api#documentation": "

The status of sending capability for the tenant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains details about a tenant.

" + } + }, + "com.amazonaws.sesv2#TenantId": { + "type": "string" + }, + "com.amazonaws.sesv2#TenantInfo": { + "type": "structure", + "members": { + "TenantName": { + "target": "com.amazonaws.sesv2#TenantName", + "traits": { + "smithy.api#documentation": "

The name of the tenant.

" + } + }, + "TenantId": { + "target": "com.amazonaws.sesv2#TenantId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the tenant.

" + } + }, + "TenantArn": { + "target": "com.amazonaws.sesv2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the tenant.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when the tenant was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains basic information about a tenant.

" + } + }, + "com.amazonaws.sesv2#TenantInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#TenantInfo" + }, + "traits": { + "smithy.api#documentation": "

A list of tenant information objects.

" + } + }, + "com.amazonaws.sesv2#TenantName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of a tenant. The name can contain up to 64 alphanumeric characters, including\n letters, numbers, hyphens (-) and underscores (_) only.

", + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.sesv2#TenantResource": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.sesv2#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource associated with the tenant. Valid values are EMAIL_IDENTITY,\n CONFIGURATION_SET, or EMAIL_TEMPLATE.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.sesv2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource associated with the tenant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information about a resource associated with a tenant.

" + } + }, + "com.amazonaws.sesv2#TenantResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#TenantResource" + }, + "traits": { + "smithy.api#documentation": "

A list of resources associated with a tenant.

" + } + }, "com.amazonaws.sesv2#TestRenderEmailTemplate": { "type": "operation", "input": { @@ -13820,6 +15040,142 @@ "smithy.api#output": {} } }, + "com.amazonaws.sesv2#UpdateReputationEntityCustomerManagedStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#UpdateReputationEntityCustomerManagedStatusRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#UpdateReputationEntityCustomerManagedStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#ConflictException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Update the customer-managed sending status for a reputation entity. This allows \n you to enable, disable, or reinstate sending for the entity.

\n

The customer-managed status works in conjunction with the Amazon Web Services Amazon SES-managed status\n to determine the overall sending capability. When you update the customer-managed status,\n the Amazon Web Services Amazon SES-managed status remains unchanged. If Amazon Web Services Amazon SES has disabled the entity,\n it will not be allowed to send regardless of the customer-managed status setting. When you\n reinstate an entity through the customer-managed status, it can continue sending only if\n the Amazon Web Services Amazon SES-managed status also permits sending, even if there are active reputation\n findings, until the findings are resolved or new violations occur.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v2/email/reputation/entities/{ReputationEntityType}/{ReputationEntityReference}/customer-managed-status", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#UpdateReputationEntityCustomerManagedStatusRequest": { + "type": "structure", + "members": { + "ReputationEntityType": { + "target": "com.amazonaws.sesv2#ReputationEntityType", + "traits": { + "smithy.api#documentation": "

The type of reputation entity. Currently, only RESOURCE type entities are supported.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ReputationEntityReference": { + "target": "com.amazonaws.sesv2#ReputationEntityReference", + "traits": { + "smithy.api#documentation": "

The unique identifier for the reputation entity. For resource-type entities, \n this is the Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SendingStatus": { + "target": "com.amazonaws.sesv2#SendingStatus", + "traits": { + "smithy.api#documentation": "

The new customer-managed sending status for the reputation entity. This can be one of the following:

\n
    \n
  • \n

    \n ENABLED – Allow sending for this entity.

    \n
    • \n
  • \n

    \n DISABLED – Prevent sending for this entity.

    \n
    • \n
  • \n

    \n REINSTATED – Allow sending even if there are active reputation findings.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to update the customer-managed sending status for a reputation entity.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#UpdateReputationEntityCustomerManagedStatusResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.sesv2#UpdateReputationEntityPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#UpdateReputationEntityPolicyRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#UpdateReputationEntityPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#ConflictException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Update the reputation management policy for a reputation entity. The policy \n determines how the entity responds to reputation findings, such as automatically \n pausing sending when certain thresholds are exceeded.

\n

Reputation management policies are Amazon Web Services Amazon SES-managed (predefined policies).\n You can select from none, standard, and strict policies.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v2/email/reputation/entities/{ReputationEntityType}/{ReputationEntityReference}/policy", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#UpdateReputationEntityPolicyRequest": { + "type": "structure", + "members": { + "ReputationEntityType": { + "target": "com.amazonaws.sesv2#ReputationEntityType", + "traits": { + "smithy.api#documentation": "

The type of reputation entity. Currently, only RESOURCE type entities are supported.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ReputationEntityReference": { + "target": "com.amazonaws.sesv2#ReputationEntityReference", + "traits": { + "smithy.api#documentation": "

The unique identifier for the reputation entity. For resource-type entities, \n this is the Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ReputationEntityPolicy": { + "target": "com.amazonaws.sesv2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the reputation management policy to apply \n to this entity. This is an Amazon Web Services Amazon SES-managed policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a request to update the reputation management policy for a reputation entity.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#UpdateReputationEntityPolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

", + "smithy.api#output": {} + } + }, "com.amazonaws.sesv2#UseCaseDescription": { "type": "string", "traits": { @@ -14070,6 +15426,12 @@ "traits": { "smithy.api#enumValue": "DONE" } + }, + "NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_APPLICABLE" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/sfn.json b/codegen/sdk/aws-models/sfn.json index 10eb0aab8c2..1862cbdb384 100644 --- a/codegen/sdk/aws-models/sfn.json +++ b/codegen/sdk/aws-models/sfn.json @@ -6125,7 +6125,7 @@ "input": { "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

The string that contains the JSON input data for the execution, for example:

\n

\n \"{\\\"first_name\\\" : \\\"Tim\\\"}\"\n

\n \n

If you don't include any JSON input data, you still must include the two braces, for\n example: \"{}\"\n

\n \n

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

" + "smithy.api#documentation": "

The string that contains the JSON input data for the execution, for example:

\n

\n \"{\\\"first_name\\\" : \\\"Alejandro\\\"}\"\n

\n \n

If you don't include any JSON input data, you still must include the two braces, for\n example: \"{}\"\n

\n \n

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

" } }, "traceHeader": { @@ -6224,7 +6224,7 @@ "input": { "target": "com.amazonaws.sfn#SensitiveData", "traits": { - "smithy.api#documentation": "

The string that contains the JSON input data for the execution, for example:

\n

\n \"{\\\"first_name\\\" : \\\"Tim\\\"}\"\n

\n \n

If you don't include any JSON input data, you still must include the two braces, for\n example: \"{}\"\n

\n \n

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

" + "smithy.api#documentation": "

The string that contains the JSON input data for the execution, for example:

\n

\n \"{\\\"first_name\\\" : \\\"Alejandro\\\"}\"\n

\n \n

If you don't include any JSON input data, you still must include the two braces, for\n example: \"{}\"\n

\n \n

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

" } }, "traceHeader": { diff --git a/codegen/sdk/aws-models/sns.json b/codegen/sdk/aws-models/sns.json index 282103c5878..715a1bce859 100644 --- a/codegen/sdk/aws-models/sns.json +++ b/codegen/sdk/aws-models/sns.json @@ -1571,7 +1571,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal and\n PlatformCredential attributes when using the\n CreatePlatformApplication action.

\n

\n PlatformPrincipal and PlatformCredential are received from\n the notification service.

\n
    \n
  • \n

    For ADM, PlatformPrincipal is client id and\n PlatformCredential is client secret.

    \n
    • \n
  • \n

    For APNS and APNS_SANDBOX using certificate credentials,\n PlatformPrincipal is SSL certificate and\n PlatformCredential is private key.

    \n
    • \n
  • \n

    For APNS and APNS_SANDBOX using token credentials,\n PlatformPrincipal is signing key ID and\n PlatformCredential is signing key.

    \n
    • \n
  • \n

    For Baidu, PlatformPrincipal is API key and\n PlatformCredential is secret key.

    \n
    • \n
  • \n

    For GCM (Firebase Cloud Messaging) using key credentials, there is no\n PlatformPrincipal. The PlatformCredential is\n API key.

    \n
    • \n
  • \n

    For GCM (Firebase Cloud Messaging) using token credentials, there is no\n PlatformPrincipal. The PlatformCredential is a\n JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in\n string format and special characters must be ignored. To format the file\n correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq\n @json <<< cat service.json`.

    \n
    • \n
  • \n

    For MPNS, PlatformPrincipal is TLS certificate and\n PlatformCredential is private key.

    \n
    • \n
  • \n

    For WNS, PlatformPrincipal is Package Security\n Identifier and PlatformCredential is secret\n key.

    \n
    • \n
\n

You can use the returned PlatformApplicationArn as an attribute for the\n CreatePlatformEndpoint action.

" + "smithy.api#documentation": "

Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal and\n PlatformCredential attributes when using the\n CreatePlatformApplication action.

\n

\n PlatformPrincipal and PlatformCredential are received from\n the notification service.

\n
    \n
  • \n

    For ADM, PlatformPrincipal is client id and\n PlatformCredential is client secret.

    \n
    • \n
  • \n

    For APNS and APNS_SANDBOX using certificate credentials,\n PlatformPrincipal is SSL certificate and\n PlatformCredential is private key.

    \n
    • \n
  • \n

    For APNS and APNS_SANDBOX using token credentials,\n PlatformPrincipal is signing key ID and\n PlatformCredential is signing key.

    \n
    • \n
  • \n

    For Baidu, PlatformPrincipal is API key and\n PlatformCredential is secret key.

    \n
    • \n
  • \n

    For GCM (Firebase Cloud Messaging) using key credentials, there is no\n PlatformPrincipal. The PlatformCredential is\n API key.

    \n
    • \n
  • \n

    For GCM (Firebase Cloud Messaging) using token credentials, there is no\n PlatformPrincipal. The PlatformCredential is a\n JSON formatted private key file. When using the Amazon Web Services CLI or Amazon Web Services SDKs, the\n file must be in string format and special characters must be ignored. To format\n the file correctly, Amazon SNS recommends using the following command:\n SERVICE_JSON=$(jq @json < service.json).

    \n
    • \n
  • \n

    For MPNS, PlatformPrincipal is TLS certificate and\n PlatformCredential is private key.

    \n
    • \n
  • \n

    For WNS, PlatformPrincipal is Package Security\n Identifier and PlatformCredential is secret\n key.

    \n
    • \n
\n

You can use the returned PlatformApplicationArn as an attribute for the\n CreatePlatformEndpoint action.

" } }, "com.amazonaws.sns#CreatePlatformApplicationInput": { @@ -1794,7 +1794,7 @@ "Attributes": { "target": "com.amazonaws.sns#TopicAttributesMap", "traits": { - "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists names, descriptions, and values of the special request parameters\n that the CreateTopic action uses:

\n
    \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
    • \n
  • \n

    \n DisplayName – The display name to use for a topic with SMS\n subscriptions.

    \n
    • \n
  • \n

    \n FifoTopic – Set to true to create a FIFO topic.

    \n
    • \n
  • \n

    \n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.

    \n
    • \n
  • \n

    \n SignatureVersion – The signature version corresponds to\n the hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion is set to 1.

    \n
    • \n
  • \n

    \n TracingConfig – Tracing mode of an Amazon SNS topic. By default\n TracingConfig is set to PassThrough, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.

    \n
    • \n
\n

The following attribute applies only to server-side\n encryption:

\n
    \n
  • \n

    \n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.

    \n
    • \n
\n

The following attributes apply only to FIFO topics:

\n
    \n
  • \n

    \n ArchivePolicy – The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.

    \n
    • \n
  • \n

    \n ContentBasedDeduplication – Enables content-based\n deduplication for FIFO topics.

    \n
      \n
    • \n

      By default, ContentBasedDeduplication is set to\n false. If you create a FIFO topic and this attribute is\n false, you must specify a value for the\n MessageDeduplicationId parameter for the Publish action.

      \n
      • \n
    • \n

      When you set ContentBasedDeduplication to\n true, Amazon SNS uses a SHA-256 hash to\n generate the MessageDeduplicationId using the body of the\n message (but not the attributes of the message).

      \n

      (Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId parameter for the\n Publish action.

      \n
      • \n
    \n
    • \n
\n
    \n
  • \n

    \n FifoThroughputScope – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:

    \n
      \n
    • \n

      \n Topic – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.

      \n
      • \n
    • \n

      \n MessageGroup – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.

      \n
      • \n
    \n
    • \n
" + "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists names, descriptions, and values of the special request parameters\n that the CreateTopic action uses:

\n
    \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
    • \n
  • \n

    \n DisplayName – The display name to use for a topic with SMS\n subscriptions.

    \n
    • \n
  • \n

    \n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.

    \n
    • \n
  • \n

    \n TracingConfig – Tracing mode of an Amazon SNS topic. By default\n TracingConfig is set to PassThrough, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.

    \n
    • \n
  • \n

    HTTP

    \n
      \n
    • \n

      \n HTTPSuccessFeedbackRoleArn – Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.

      \n
      • \n
    • \n

      \n HTTPSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an HTTP endpoint.

      \n
      • \n
    • \n

      \n HTTPFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.

      \n
      • \n
    \n
    • \n
  • \n

    Amazon Data Firehose

    \n
      \n
    • \n

      \n FirehoseSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Amazon Data Firehose endpoint.

      \n
      • \n
    • \n

      \n FirehoseSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon Data Firehose endpoint.

      \n
      • \n
    • \n

      \n FirehoseFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon Data Firehose endpoint.

      \n
      • \n
    \n
    • \n
  • \n

    Lambda

    \n
      \n
    • \n

      \n LambdaSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Lambda endpoint.

      \n
      • \n
    • \n

      \n LambdaSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Lambda endpoint.

      \n
      • \n
    • \n

      \n LambdaFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Lambda endpoint.

      \n
      • \n
    \n
    • \n
  • \n

    Platform application endpoint

    \n
      \n
    • \n

      \n ApplicationSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to a platform application endpoint.

      \n
      • \n
    • \n

      \n ApplicationSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an platform application endpoint.

      \n
      • \n
    • \n

      \n ApplicationFailureFeedbackRoleArn – Indicates\n failed message delivery status for an Amazon SNS topic that is subscribed to\n an platform application endpoint.

      \n
      • \n
    \n \n

    In addition to being able to configure topic attributes for message\n delivery status of notification messages sent to Amazon SNS application\n endpoints, you can also configure application attributes for the delivery\n status of push notification messages sent to push notification\n services.

    \n

    For example, For more information, see Using Amazon SNS Application\n Attributes for Message Delivery Status.

    \n     \n
    • \n
  • \n

    Amazon SQS

    \n
      \n
    • \n

      \n SQSSuccessFeedbackRoleArn – Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.

      \n
      • \n
    • \n

      \n SQSSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon SQS endpoint.

      \n
      • \n
    • \n

      \n SQSFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.

      \n
      • \n
    \n
    • \n
\n \n

The SuccessFeedbackRoleArn and FailureFeedbackRoleArn\n attributes are used to give Amazon SNS write access to use CloudWatch Logs on your\n behalf. The SuccessFeedbackSampleRate attribute is for specifying the\n sample rate percentage (0-100) of successfully delivered messages. After you\n configure the FailureFeedbackRoleArn attribute, then all failed message\n deliveries generate CloudWatch Logs.

\n \n

The following attribute applies only to server-side\n encryption:

\n
    \n
  • \n

    \n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.

    \n
    • \n
\n

The following attributes apply only to FIFO topics:

\n
    \n
  • \n

    \n ArchivePolicy – The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.

    \n
    • \n
  • \n

    \n ContentBasedDeduplication – Enables content-based\n deduplication for FIFO topics.

    \n
      \n
    • \n

      By default, ContentBasedDeduplication is set to\n false. If you create a FIFO topic and this attribute is\n false, you must specify a value for the\n MessageDeduplicationId parameter for the Publish action.

      \n
      • \n
    • \n

      When you set ContentBasedDeduplication to\n true, Amazon SNS uses a SHA-256 hash to\n generate the MessageDeduplicationId using the body of the\n message (but not the attributes of the message).

      \n

      (Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId parameter for the\n Publish action.

      \n
      • \n
    \n
    • \n
\n
    \n
  • \n

    \n FifoThroughputScope – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:

    \n
      \n
    • \n

      \n Topic – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.

      \n
      • \n
    • \n

      \n MessageGroup – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.

      \n
      • \n
    \n
    • \n
" } }, "Tags": { @@ -2093,7 +2093,7 @@ "code": "FilterPolicyLimitExceeded", "httpResponseCode": 403 }, - "smithy.api#documentation": "

Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To\n add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support\n Center.

", + "smithy.api#documentation": "

Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To\n add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web ServicesSupport\n Center.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -3884,7 +3884,7 @@ } ], "traits": { - "smithy.api#documentation": "

Publishes up to ten messages to the specified topic. This is a batch version of\n Publish. For FIFO topics, multiple messages within a single batch are\n published in the order they are sent, and messages are deduplicated within the batch and\n across batches for 5 minutes.

\n

The result of publishing each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful\n actions, you should check for batch errors even when the call returns an HTTP status\n code of 200.

\n

The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KB (262,144\n bytes).

\n

Some actions take lists of parameters. These lists are specified using the\n param.n notation. Values of n are integers starting from\n 1. For example, a parameter list with two elements looks like this:

\n

&AttributeName.1=first

\n

&AttributeName.2=second

\n

If you send a batch message to a topic, Amazon SNS publishes the batch message to each\n endpoint that is subscribed to the topic. The format of the batch message depends on the\n notification protocol for each subscribed endpoint.

\n

When a messageId is returned, the batch message is saved and Amazon SNS\n immediately delivers the message to subscribers.

" + "smithy.api#documentation": "

Publishes up to 10 messages to the specified topic in a single batch. This is a batch\n version of the Publish API. If you try to send more than 10 messages in a\n single batch request, you will receive a TooManyEntriesInBatchRequest\n exception.

\n

For FIFO topics, multiple messages within a single batch are published in the order\n they are sent, and messages are deduplicated within the batch and across batches for\n five minutes.

\n

The result of publishing each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful\n actions, you should check for batch errors even when the call returns an HTTP status\n code of 200.

\n

The maximum allowed individual message size and the maximum total payload size (the sum\n of the individual lengths of all of the batched messages) are both 256 KB (262,144\n bytes).

\n \n

The PublishBatch API can send up to 10 messages at a time. If you\n attempt to send more than 10 messages in one request, you will encounter a\n TooManyEntriesInBatchRequest exception. In such cases, split your\n messages into multiple requests, each containing no more than 10 messages.

\n \n

Some actions take lists of parameters. These lists are specified using the\n param.n notation. Values of n are integers starting from\n 1. For example, a parameter list with two elements\n looks like this:

\n

\n &AttributeName.1=first\n

\n

\n &AttributeName.2=second\n

\n

If you send a batch message to a topic, Amazon SNS publishes the batch message to each\n endpoint that is subscribed to the topic. The format of the batch message depends on the\n notification protocol for each subscribed endpoint.

\n

When a messageId is returned, the batch message is saved, and Amazon SNS\n immediately delivers the message to subscribers.

" } }, "com.amazonaws.sns#PublishBatchInput": { @@ -3935,7 +3935,7 @@ "MessageStructure": { "target": "com.amazonaws.sns#messageStructure", "traits": { - "smithy.api#documentation": "

Set MessageStructure to json if you want to send a different\n message for each protocol. For example, using one publish action, you can send a short\n message to your SMS subscribers and a longer message to your email subscribers. If you\n set MessageStructure to json, the value of the\n Message parameter must:

\n
    \n
  • \n

    be a syntactically valid JSON object; and

    \n
    • \n
  • \n

    contain at least a top-level JSON key of \"default\" with a value that is a\n string.

    \n
    • \n
\n

You can define other top-level keys that define the message you want to send to a\n specific transport protocol (e.g. http).

" + "smithy.api#documentation": "

Set MessageStructure to json if you want to send a different\n message for each protocol. For example, using one publish action, you can send a short\n message to your SMS subscribers and a longer message to your email subscribers. If you\n set MessageStructure to json, the value of the\n Message parameter must:

\n
    \n
  • \n

    be a syntactically valid JSON object; and

    \n
    • \n
  • \n

    contain at least a top-level JSON key of \"default\" with a value that is a\n string.

    \n
    • \n
\n

You can define other top-level keys that define the message you want to send to a\n specific transport protocol (for example, http).

" } }, "MessageAttributes": { @@ -3953,7 +3953,7 @@ "MessageGroupId": { "target": "com.amazonaws.sns#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics.

\n

The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however, messages\n in different message groups might be processed out of order). To interleave multiple\n ordered streams within a single topic, use MessageGroupId values (for\n example, session data for multiple users). In this scenario, multiple consumers can\n process the topic, but the session data of each user is processed in a FIFO fashion.

\n

You must associate a non-empty MessageGroupId with a message. If you\n don't provide a MessageGroupId, the action fails.

\n

The length of MessageGroupId is 128 characters.

\n

\n MessageGroupId can contain alphanumeric characters (a-z, A-Z,\n 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n \n

\n MessageGroupId is required for FIFO topics. You can't use it for\n standard topics.

\n " + "smithy.api#documentation": "

FIFO topics: The tag that specifies that a message belongs to a specific message group.\n Messages that belong to the same message group are processed in a FIFO manner\n (however, messages in different message groups might be processed out of order). \n To interleave multiple ordered streams within a single topic, use MessageGroupId values \n (for example, session data for multiple users). In this scenario, multiple consumers can process the topic, \n but the session data of each user is processed in a FIFO fashion. \n You must associate a non-empty MessageGroupId with a message. \n If you do not provide a MessageGroupId, the action fails.\n

\n

Standard topics: The MessageGroupId is optional and is forwarded only to Amazon SQS \n standard subscriptions to activate fair queues. \n The MessageGroupId is not used for, or sent to, any other endpoint types.

\n

The length of MessageGroupId is 128 characters.

\n

\n MessageGroupId can contain alphanumeric characters (a-z, A-Z,\n 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

" } } }, @@ -4074,7 +4074,7 @@ "MessageGroupId": { "target": "com.amazonaws.sns#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics. The\n MessageGroupId can contain up to 128 alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

The MessageGroupId is a tag that specifies that a message belongs to a\n specific message group. Messages that belong to the same message group are processed in\n a FIFO manner (however, messages in different message groups might be processed out of\n order). Every message must include a MessageGroupId.

" + "smithy.api#documentation": "

The\n MessageGroupId can contain up to 128 alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

\n For FIFO topics: The MessageGroupId is a tag that specifies that a message belongs to a\n specific message group. Messages that belong to the same message group are processed in\n a FIFO manner (however, messages in different message groups might be processed out of\n order). Every message must include a MessageGroupId.\n

\n

\n For standard topics: The MessageGroupId is optional\n and is forwarded only to Amazon SQS standard subscriptions to activate fair queues.\n The MessageGroupId is not used for, or sent to, any other endpoint types.\n When provided, the same validation rules apply as for FIFO topics.\n

" } } }, @@ -4561,7 +4561,7 @@ "AttributeName": { "target": "com.amazonaws.sns#attributeName", "traits": { - "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the SetTopicAttributes action uses:

\n
    \n
  • \n

    \n ApplicationSuccessFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to a platform\n application endpoint.

    \n
    • \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
    • \n
  • \n

    \n DisplayName – The display name to use for a topic with SMS\n subscriptions.

    \n
    • \n
  • \n

    \n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.

    \n
    • \n
  • \n

    \n TracingConfig – Tracing mode of an Amazon SNS topic. By default\n TracingConfig is set to PassThrough, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.

    \n
    • \n
  • \n

    HTTP

    \n
      \n
    • \n

      \n HTTPSuccessFeedbackRoleArn – Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.

      \n
      • \n
    • \n

      \n HTTPSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an HTTP endpoint.

      \n
      • \n
    • \n

      \n HTTPFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.

      \n
      • \n
    \n
    • \n
  • \n

    Amazon Kinesis Data Firehose

    \n
      \n
    • \n

      \n FirehoseSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Amazon Kinesis Data Firehose endpoint.

      \n
      • \n
    • \n

      \n FirehoseSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon Kinesis Data Firehose endpoint.

      \n
      • \n
    • \n

      \n FirehoseFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon Kinesis Data Firehose endpoint.

      \n
      • \n
    \n
    • \n
  • \n

    Lambda

    \n
      \n
    • \n

      \n LambdaSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Lambda endpoint.

      \n
      • \n
    • \n

      \n LambdaSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Lambda endpoint.

      \n
      • \n
    • \n

      \n LambdaFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Lambda endpoint.

      \n
      • \n
    \n
    • \n
  • \n

    Platform application endpoint

    \n
      \n
    • \n

      \n ApplicationSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Amazon Web Services application endpoint.

      \n
      • \n
    • \n

      \n ApplicationSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon Web Services application endpoint.

      \n
      • \n
    • \n

      \n ApplicationFailureFeedbackRoleArn – Indicates\n failed message delivery status for an Amazon SNS topic that is subscribed to\n an Amazon Web Services application endpoint.

      \n
      • \n
    \n \n

    In addition to being able to configure topic attributes for message\n delivery status of notification messages sent to Amazon SNS application\n endpoints, you can also configure application attributes for the delivery\n status of push notification messages sent to push notification\n services.

    \n

    For example, For more information, see Using Amazon SNS Application\n Attributes for Message Delivery Status.

    \n     \n
    • \n
  • \n

    Amazon SQS

    \n
      \n
    • \n

      \n SQSSuccessFeedbackRoleArn – Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.

      \n
      • \n
    • \n

      \n SQSSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon SQS endpoint.

      \n
      • \n
    • \n

      \n SQSFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.

      \n
      • \n
    \n
    • \n
\n \n

The SuccessFeedbackRoleArn and FailureFeedbackRoleArn\n attributes are used to give Amazon SNS write access to use CloudWatch Logs on your\n behalf. The SuccessFeedbackSampleRate attribute is for specifying the\n sample rate percentage (0-100) of successfully delivered messages. After you\n configure the FailureFeedbackRoleArn attribute, then all failed message\n deliveries generate CloudWatch Logs.

\n \n

The following attribute applies only to server-side-encryption:

\n
    \n
  • \n

    \n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.

    \n
    • \n
  • \n

    \n SignatureVersion – The signature version corresponds to the\n hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion is set to 1.

    \n
    • \n
\n

The following attribute applies only to FIFO topics:

\n
    \n
  • \n

    \n ArchivePolicy – The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.

    \n
    • \n
  • \n

    \n ContentBasedDeduplication – Enables content-based\n deduplication for FIFO topics.

    \n
      \n
    • \n

      By default, ContentBasedDeduplication is set to\n false. If you create a FIFO topic and this attribute is\n false, you must specify a value for the\n MessageDeduplicationId parameter for the Publish action.

      \n
      • \n
    • \n

      When you set ContentBasedDeduplication to\n true, Amazon SNS uses a SHA-256 hash to\n generate the MessageDeduplicationId using the body of the\n message (but not the attributes of the message).

      \n

      (Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId parameter for the\n Publish action.

      \n
      • \n
    \n
    • \n
\n
    \n
  • \n

    \n FifoThroughputScope – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:

    \n
      \n
    • \n

      \n Topic – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.

      \n
      • \n
    • \n

      \n MessageGroup – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.

      \n
      • \n
    \n
    • \n
", + "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the SetTopicAttributes action uses:

\n
    \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
    • \n
  • \n

    \n DisplayName – The display name to use for a topic with SMS\n subscriptions.

    \n
    • \n
  • \n

    \n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.

    \n
    • \n
  • \n

    \n TracingConfig – Tracing mode of an Amazon SNS topic. By default\n TracingConfig is set to PassThrough, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.

    \n
    • \n
  • \n

    HTTP

    \n
      \n
    • \n

      \n HTTPSuccessFeedbackRoleArn – Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.

      \n
      • \n
    • \n

      \n HTTPSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an HTTP endpoint.

      \n
      • \n
    • \n

      \n HTTPFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an HTTP\n endpoint.

      \n
      • \n
    \n
    • \n
  • \n

    Amazon Data Firehose

    \n
      \n
    • \n

      \n FirehoseSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Amazon Data Firehose endpoint.

      \n
      • \n
    • \n

      \n FirehoseSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon Data Firehose endpoint.

      \n
      • \n
    • \n

      \n FirehoseFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon Data Firehose endpoint.

      \n
      • \n
    \n
    • \n
  • \n

    Lambda

    \n
      \n
    • \n

      \n LambdaSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an Lambda endpoint.

      \n
      • \n
    • \n

      \n LambdaSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Lambda endpoint.

      \n
      • \n
    • \n

      \n LambdaFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Lambda endpoint.

      \n
      • \n
    \n
    • \n
  • \n

    Platform application endpoint

    \n
      \n
    • \n

      \n ApplicationSuccessFeedbackRoleArn – Indicates\n successful message delivery status for an Amazon SNS topic that is subscribed\n to an platform application endpoint.

      \n
      • \n
    • \n

      \n ApplicationSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an platform application endpoint.

      \n
      • \n
    • \n

      \n ApplicationFailureFeedbackRoleArn – Indicates\n failed message delivery status for an Amazon SNS topic that is subscribed to\n an platform application endpoint.

      \n
      • \n
    \n \n

    In addition to being able to configure topic attributes for message\n delivery status of notification messages sent to Amazon SNS application\n endpoints, you can also configure application attributes for the delivery\n status of push notification messages sent to push notification\n services.

    \n

    For example, For more information, see Using Amazon SNS Application\n Attributes for Message Delivery Status.

    \n     \n
    • \n
  • \n

    Amazon SQS

    \n
      \n
    • \n

      \n SQSSuccessFeedbackRoleArn – Indicates successful\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.

      \n
      • \n
    • \n

      \n SQSSuccessFeedbackSampleRate – Indicates\n percentage of successful messages to sample for an Amazon SNS topic that is\n subscribed to an Amazon SQS endpoint.

      \n
      • \n
    • \n

      \n SQSFailureFeedbackRoleArn – Indicates failed\n message delivery status for an Amazon SNS topic that is subscribed to an\n Amazon SQS endpoint.

      \n
      • \n
    \n
    • \n
\n \n

The SuccessFeedbackRoleArn and FailureFeedbackRoleArn\n attributes are used to give Amazon SNS write access to use CloudWatch Logs on your\n behalf. The SuccessFeedbackSampleRate attribute is for specifying the\n sample rate percentage (0-100) of successfully delivered messages. After you\n configure the FailureFeedbackRoleArn attribute, then all failed message\n deliveries generate CloudWatch Logs.

\n \n

The following attribute applies only to server-side-encryption:

\n
    \n
  • \n

    \n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.

    \n
    • \n
  • \n

    \n SignatureVersion – The signature version corresponds to the\n hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion is set to 1.

    \n
    • \n
\n

The following attribute applies only to FIFO topics:

\n
    \n
  • \n

    \n ArchivePolicy – The policy that sets the retention period\n for messages stored in the message archive of an Amazon SNS FIFO\n topic.

    \n
    • \n
  • \n

    \n ContentBasedDeduplication – Enables content-based\n deduplication for FIFO topics.

    \n
      \n
    • \n

      By default, ContentBasedDeduplication is set to\n false. If you create a FIFO topic and this attribute is\n false, you must specify a value for the\n MessageDeduplicationId parameter for the Publish action.

      \n
      • \n
    • \n

      When you set ContentBasedDeduplication to\n true, Amazon SNS uses a SHA-256 hash to\n generate the MessageDeduplicationId using the body of the\n message (but not the attributes of the message).

      \n

      (Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId parameter for the\n Publish action.

      \n
      • \n
    \n
    • \n
\n
    \n
  • \n

    \n FifoThroughputScope – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:

    \n
      \n
    • \n

      \n Topic – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.

      \n
      • \n
    • \n

      \n MessageGroup – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see Amazon SNS service quotas in the Amazon Web Services General Reference.

      \n
      • \n
    \n
    • \n
", "smithy.api#required": {} } }, @@ -4648,14 +4648,14 @@ "Protocol": { "target": "com.amazonaws.sns#protocol", "traits": { - "smithy.api#documentation": "

The protocol that you want to use. Supported protocols include:

\n
    \n
  • \n

    \n http – delivery of JSON-encoded message via HTTP\n POST

    \n
    • \n
  • \n

    \n https – delivery of JSON-encoded message via HTTPS\n POST

    \n
    • \n
  • \n

    \n email – delivery of message via SMTP

    \n
    • \n
  • \n

    \n email-json – delivery of JSON-encoded message via\n SMTP

    \n
    • \n
  • \n

    \n sms – delivery of message via SMS

    \n
    • \n
  • \n

    \n sqs – delivery of JSON-encoded message to an Amazon SQS\n queue

    \n
    • \n
  • \n

    \n application – delivery of JSON-encoded message to an\n EndpointArn for a mobile app and device

    \n
    • \n
  • \n

    \n lambda – delivery of JSON-encoded message to an Lambda\n function

    \n
    • \n
  • \n

    \n firehose – delivery of JSON-encoded message to an Amazon\n Kinesis Data Firehose delivery stream.

    \n
    • \n
", + "smithy.api#documentation": "

The protocol that you want to use. Supported protocols include:

\n
    \n
  • \n

    \n http – delivery of JSON-encoded message via HTTP\n POST

    \n
    • \n
  • \n

    \n https – delivery of JSON-encoded message via HTTPS\n POST

    \n
    • \n
  • \n

    \n email – delivery of message via SMTP

    \n
    • \n
  • \n

    \n email-json – delivery of JSON-encoded message via\n SMTP

    \n
    • \n
  • \n

    \n sms – delivery of message via SMS

    \n
    • \n
  • \n

    \n sqs – delivery of JSON-encoded message to an Amazon SQS\n queue

    \n
    • \n
  • \n

    \n application – delivery of JSON-encoded message to an\n EndpointArn for a mobile app and device

    \n
    • \n
  • \n

    \n lambda – delivery of JSON-encoded message to an Lambda\n function

    \n
    • \n
  • \n

    \n firehose – delivery of JSON-encoded message to an Amazon\n Data Firehose delivery stream.

    \n
    • \n
", "smithy.api#required": {} } }, "Endpoint": { "target": "com.amazonaws.sns#Endpoint2", "traits": { - "smithy.api#documentation": "

The endpoint that you want to receive notifications. Endpoints vary by\n protocol:

\n
    \n
  • \n

    For the http protocol, the (public) endpoint is a URL beginning\n with http://.

    \n
    • \n
  • \n

    For the https protocol, the (public) endpoint is a URL beginning\n with https://.

    \n
    • \n
  • \n

    For the email protocol, the endpoint is an email address.

    \n
    • \n
  • \n

    For the email-json protocol, the endpoint is an email\n address.

    \n
    • \n
  • \n

    For the sms protocol, the endpoint is a phone number of an\n SMS-enabled device.

    \n
    • \n
  • \n

    For the sqs protocol, the endpoint is the ARN of an Amazon SQS\n queue.

    \n
    • \n
  • \n

    For the application protocol, the endpoint is the EndpointArn of\n a mobile app and device.

    \n
    • \n
  • \n

    For the lambda protocol, the endpoint is the ARN of an Lambda\n function.

    \n
    • \n
  • \n

    For the firehose protocol, the endpoint is the ARN of an Amazon\n Kinesis Data Firehose delivery stream.

    \n
    • \n
" + "smithy.api#documentation": "

The endpoint that you want to receive notifications. Endpoints vary by\n protocol:

\n
    \n
  • \n

    For the http protocol, the (public) endpoint is a URL beginning\n with http://.

    \n
    • \n
  • \n

    For the https protocol, the (public) endpoint is a URL beginning\n with https://.

    \n
    • \n
  • \n

    For the email protocol, the endpoint is an email address.

    \n
    • \n
  • \n

    For the email-json protocol, the endpoint is an email\n address.

    \n
    • \n
  • \n

    For the sms protocol, the endpoint is a phone number of an\n SMS-enabled device.

    \n
    • \n
  • \n

    For the sqs protocol, the endpoint is the ARN of an Amazon SQS\n queue.

    \n
    • \n
  • \n

    For the application protocol, the endpoint is the EndpointArn of\n a mobile app and device.

    \n
    • \n
  • \n

    For the lambda protocol, the endpoint is the ARN of an Lambda\n function.

    \n
    • \n
  • \n

    For the firehose protocol, the endpoint is the ARN of an Amazon\n Data Firehose delivery stream.

    \n
    • \n
" } }, "Attributes": { @@ -4947,7 +4947,7 @@ "code": "TooManyEntriesInBatchRequest", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The batch request contains more entries than permissible.

", + "smithy.api#documentation": "

The batch request contains more entries than permissible (more than 10).

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -5024,7 +5024,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a subscription. If the subscription requires authentication for deletion, only\n the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services\n signature is required. If the Unsubscribe call does not require\n authentication and the requester is not the subscription owner, a final cancellation\n message is delivered to the endpoint, so that the endpoint owner can easily resubscribe\n to the topic if the Unsubscribe request was unintended.

\n \n

Amazon SQS queue subscriptions require authentication for deletion. Only the owner of\n the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services\n signature.

\n \n

This action is throttled at 100 transactions per second (TPS).

" + "smithy.api#documentation": "

Deletes a subscription. If the subscription requires authentication for deletion, only\n the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services\n signature is required. If the Unsubscribe call does not require\n authentication and the requester is not the subscription owner, a final cancellation\n message is delivered to the endpoint, so that the endpoint owner can easily resubscribe\n to the topic if the Unsubscribe request was unintended.

\n

This action is throttled at 100 transactions per second (TPS).

" } }, "com.amazonaws.sns#UnsubscribeInput": { diff --git a/codegen/sdk/aws-models/socialmessaging.json b/codegen/sdk/aws-models/socialmessaging.json index b1ec4bc5980..30e60f7d9b3 100644 --- a/codegen/sdk/aws-models/socialmessaging.json +++ b/codegen/sdk/aws-models/socialmessaging.json @@ -27,6 +27,18 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.socialmessaging#AddContactNumber": { + "type": "boolean" + }, + "com.amazonaws.socialmessaging#AddLearnMoreLink": { + "type": "boolean" + }, + "com.amazonaws.socialmessaging#AddSecurityRecommendation": { + "type": "boolean" + }, + "com.amazonaws.socialmessaging#AddTrackPackageLink": { + "type": "boolean" + }, "com.amazonaws.socialmessaging#Arn": { "type": "string", "traits": { @@ -60,6 +72,9 @@ { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, + { + "target": "com.amazonaws.socialmessaging#LimitExceededException" + }, { "target": "com.amazonaws.socialmessaging#ThrottledRequestException" } @@ -118,18 +133,61 @@ "smithy.api#output": {} } }, - "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMedia": { + "com.amazonaws.socialmessaging#ButtonType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.socialmessaging#CodeExpirationMinutes": { + "type": "integer" + }, + "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaInput" + "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateInput" }, "output": { - "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaOutput" + "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateOutput" }, "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": "

Creates a new WhatsApp message template from a custom definition.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/whatsapp/template/put", + "code": 200 + } + } + }, + "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateFromLibrary": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateFromLibraryInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateFromLibraryOutput" + }, + "errors": [ { "target": "com.amazonaws.socialmessaging#DependencyException" }, @@ -147,33 +205,29 @@ } ], "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#documentation": "

Creates a new WhatsApp message template using a template from Meta's template library.

", "smithy.api#http": { - "method": "DELETE", - "uri": "/v1/whatsapp/media", + "method": "POST", + "uri": "/v1/whatsapp/template/create", "code": 200 - }, - "smithy.api#idempotent": {} + } } }, - "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaInput": { + "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateFromLibraryInput": { "type": "structure", "members": { - "mediaId": { - "target": "com.amazonaws.socialmessaging#WhatsAppMediaId", + "metaLibraryTemplate": { + "target": "com.amazonaws.socialmessaging#MetaLibraryTemplate", "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#documentation": "

The template configuration from Meta's library, including customizations for buttons and body text.

", "smithy.api#required": {} } }, - "originationPhoneNumberId": { - "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", + "id": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "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" + "smithy.api#documentation": "

The ID of the WhatsApp Business Account to associate with this template.

", + "smithy.api#required": {} } } }, @@ -181,13 +235,25 @@ "smithy.api#input": {} } }, - "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaOutput": { + "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateFromLibraryOutput": { "type": "structure", "members": { - "success": { - "target": "smithy.api#Boolean", + "metaTemplateId": { + "target": "com.amazonaws.socialmessaging#MetaTemplateId", "traits": { - "smithy.api#documentation": "

Success indicator for deleting the media file.

" + "smithy.api#documentation": "

The numeric ID assigned to the template by Meta.

" + } + }, + "templateStatus": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status of the created template (for example, PENDING or APPROVED).

" + } + }, + "category": { + "target": "com.amazonaws.socialmessaging#MetaTemplateCategory", + "traits": { + "smithy.api#documentation": "

The category of the template (for example, UTILITY or MARKETING).

" } } }, @@ -195,32 +261,43 @@ "smithy.api#output": {} } }, - "com.amazonaws.socialmessaging#DependencyException": { + "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateInput": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.socialmessaging#ErrorMessage" + "templateDefinition": { + "target": "com.amazonaws.socialmessaging#MetaTemplateDefinition", + "traits": { + "smithy.api#documentation": "

The complete template definition as a JSON blob.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the WhatsApp Business Account to associate with this template.

", + "smithy.api#required": {} + } } }, "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": {} + "smithy.api#input": {} } }, - "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccount": { + "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateMedia": { "type": "operation", "input": { - "target": "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccountInput" + "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateMediaInput" }, "output": { - "target": "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccountOutput" + "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateMediaOutput" }, "errors": [ { "target": "com.amazonaws.socialmessaging#DependencyException" }, + { + "target": "com.amazonaws.socialmessaging#InternalServiceException" + }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, @@ -232,60 +309,87 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.

", + "smithy.api#documentation": "

Uploads media for use in a WhatsApp message template.

", "smithy.api#http": { - "method": "DELETE", - "uri": "/v1/whatsapp/waba/disassociate", + "method": "POST", + "uri": "/v1/whatsapp/template/media", "code": 200 - }, - "smithy.api#idempotent": {} + } } }, - "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccountInput": { + "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateMediaInput": { "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" + "smithy.api#documentation": "

The ID of the WhatsApp Business Account associated with this media upload.

", + "smithy.api#required": {} } + }, + "sourceS3File": { + "target": "com.amazonaws.socialmessaging#S3File" } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccountOutput": { + "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateMediaOutput": { "type": "structure", - "members": {}, + "members": { + "metaHeaderHandle": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The handle assigned to the uploaded media by Meta, used to reference the media in templates.

" + } + } + }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.socialmessaging#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.socialmessaging#EventDestinationArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 + "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateOutput": { + "type": "structure", + "members": { + "metaTemplateId": { + "target": "com.amazonaws.socialmessaging#MetaTemplateId", + "traits": { + "smithy.api#documentation": "

The numeric ID assigned to the template by Meta.

" + } }, - "smithy.api#pattern": "^arn:.*:[a-z-]+([/:](.*))?$" + "templateStatus": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status of the created template, such as PENDING or APPROVED..

" + } + }, + "category": { + "target": "com.amazonaws.socialmessaging#MetaTemplateCategory", + "traits": { + "smithy.api#documentation": "

The category of the template, such as UTILITY or MARKETING.

" + } + } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccount": { + "com.amazonaws.socialmessaging#DeleteAllLanguages": { + "type": "boolean" + }, + "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMedia": { "type": "operation", "input": { - "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountInput" + "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaInput" }, "output": { - "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountOutput" + "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaOutput" }, "errors": [ + { + "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" + }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, @@ -303,25 +407,33 @@ } ], "traits": { - "smithy.api#documentation": "

Get the details of your linked WhatsApp Business Account.

", + "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": "GET", - "uri": "/v1/whatsapp/waba/details", + "method": "DELETE", + "uri": "/v1/whatsapp/media", "code": 200 }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountInput": { + "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaInput": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "mediaId": { + "target": "com.amazonaws.socialmessaging#WhatsAppMediaId", "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#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": "WabaId" + "smithy.api#resourceIdentifier": "OriginationPhoneNumberId" } } }, @@ -329,13 +441,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountOutput": { + "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaOutput": { "type": "structure", "members": { - "account": { - "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccount", + "success": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

The details of the linked WhatsApp Business Account.

" + "smithy.api#documentation": "

Success indicator for deleting the media file.

" } } }, @@ -343,13 +455,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumber": { + "com.amazonaws.socialmessaging#DeleteWhatsAppMessageTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumberInput" + "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageTemplateInput" }, "output": { - "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumberOutput" + "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageTemplateOutput" }, "errors": [ { @@ -369,25 +481,46 @@ } ], "traits": { - "smithy.api#documentation": "

Use your WhatsApp phone number id to get the WABA account id and phone number\n details.

", + "smithy.api#documentation": "

Deletes a WhatsApp message template.

", "smithy.api#http": { - "method": "GET", - "uri": "/v1/whatsapp/waba/phone/details", + "method": "DELETE", + "uri": "/v1/whatsapp/template", "code": 200 }, - "smithy.api#readonly": {} + "smithy.api#idempotent": {} } }, - "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumberInput": { + "com.amazonaws.socialmessaging#DeleteWhatsAppMessageTemplateInput": { "type": "structure", "members": { + "metaTemplateId": { + "target": "com.amazonaws.socialmessaging#MetaTemplateId", + "traits": { + "smithy.api#documentation": "

The numeric ID of the template assigned by Meta.

", + "smithy.api#httpQuery": "metaTemplateId" + } + }, + "deleteAllLanguages": { + "target": "com.amazonaws.socialmessaging#DeleteAllLanguages", + "traits": { + "smithy.api#documentation": "

If true, deletes all language versions of the template.

", + "smithy.api#httpQuery": "deleteAllTemplates" + } + }, "id": { - "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "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#documentation": "

The ID of the WhatsApp Business Account associated with this template.

", "smithy.api#httpQuery": "id", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "OriginationPhoneNumberId" + "smithy.api#required": {} + } + }, + "templateName": { + "target": "com.amazonaws.socialmessaging#MetaTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the template to delete.

", + "smithy.api#httpQuery": "templateName", + "smithy.api#required": {} } } }, @@ -395,41 +528,39 @@ "smithy.api#input": {} } }, - "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumberOutput": { + "com.amazonaws.socialmessaging#DeleteWhatsAppMessageTemplateOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#DependencyException": { "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.

" - } + "message": { + "target": "com.amazonaws.socialmessaging#ErrorMessage" } }, "traits": { - "smithy.api#output": {} + "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#GetWhatsAppMessageMedia": { + "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccount": { "type": "operation", "input": { - "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageMediaInput" + "target": "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccountInput" }, "output": { - "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageMediaOutput" + "target": "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccountOutput" }, "errors": [ - { - "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" - }, { "target": "com.amazonaws.socialmessaging#DependencyException" }, - { - "target": "com.amazonaws.socialmessaging#InternalServiceException" - }, { "target": "com.amazonaws.socialmessaging#InvalidParametersException" }, @@ -441,68 +572,991 @@ } ], "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#documentation": "

Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.

", "smithy.api#http": { - "method": "POST", + "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#Filter": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "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#GetWhatsAppMessageTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageTemplateInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageTemplateOutput" + }, + "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": "

Retrieves a specific WhatsApp message template.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/whatsapp/template", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.socialmessaging#GetWhatsAppMessageTemplateInput": { + "type": "structure", + "members": { + "metaTemplateId": { + "target": "com.amazonaws.socialmessaging#MetaTemplateId", + "traits": { + "smithy.api#documentation": "

The numeric ID of the template assigned by Meta.

", + "smithy.api#httpQuery": "metaTemplateId", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the WhatsApp Business Account associated with this template.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#GetWhatsAppMessageTemplateOutput": { + "type": "structure", + "members": { + "template": { + "target": "com.amazonaws.socialmessaging#MetaTemplate", + "traits": { + "smithy.api#documentation": "

The complete template definition as a JSON string (maximum 6000 characters).

" + } + } + }, + "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#LibraryTemplateBodyInputs": { + "type": "structure", + "members": { + "addContactNumber": { + "target": "com.amazonaws.socialmessaging#AddContactNumber", + "traits": { + "smithy.api#documentation": "

When true, includes a contact number in the template body.

" + } + }, + "addLearnMoreLink": { + "target": "com.amazonaws.socialmessaging#AddLearnMoreLink", + "traits": { + "smithy.api#documentation": "

When true, includes a \"learn more\" link in the template body.

" + } + }, + "addSecurityRecommendation": { + "target": "com.amazonaws.socialmessaging#AddSecurityRecommendation", + "traits": { + "smithy.api#documentation": "

When true, includes security recommendations in the template body.

" + } + }, + "addTrackPackageLink": { + "target": "com.amazonaws.socialmessaging#AddTrackPackageLink", + "traits": { + "smithy.api#documentation": "

When true, includes a package tracking link in the template body.

" + } + }, + "codeExpirationMinutes": { + "target": "com.amazonaws.socialmessaging#CodeExpirationMinutes", + "traits": { + "smithy.api#documentation": "

The number of minutes until a verification code or OTP expires.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration options for customizing the body content of a template from Meta's library.

" + } + }, + "com.amazonaws.socialmessaging#LibraryTemplateButtonInput": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.socialmessaging#ButtonType", + "traits": { + "smithy.api#documentation": "

The type of button (for example, QUICK_REPLY, CALL, or URL).

" + } + }, + "phoneNumber": { + "target": "com.amazonaws.socialmessaging#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number in E.164 format for CALL-type buttons.

" + } + }, + "url": { + "target": "com.amazonaws.socialmessaging#MetaUrlWithSuffixExample", + "traits": { + "smithy.api#documentation": "

The URL with dynamic parameters for URL-type buttons.

" + } + }, + "otpType": { + "target": "com.amazonaws.socialmessaging#OtpType", + "traits": { + "smithy.api#documentation": "

The type of one-time password for OTP buttons.

" + } + }, + "zeroTapTermsAccepted": { + "target": "com.amazonaws.socialmessaging#ZeroTapTermsAccepted", + "traits": { + "smithy.api#documentation": "

When true, indicates acceptance of zero-tap terms for the button.

" + } + }, + "supportedApps": { + "target": "com.amazonaws.socialmessaging#SupportedApps", + "traits": { + "smithy.api#documentation": "

List of supported applications for this button type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration options for customizing buttons in a template from Meta's library.

" + } + }, + "com.amazonaws.socialmessaging#LibraryTemplateButtonList": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.socialmessaging#ButtonType", + "traits": { + "smithy.api#documentation": "

The type of button (for example, QUICK_REPLY, CALL, or URL).

" + } + }, + "text": { + "target": "com.amazonaws.socialmessaging#MetaText", + "traits": { + "smithy.api#documentation": "

The text displayed on the button (maximum 40 characters).

" + } + }, + "phoneNumber": { + "target": "com.amazonaws.socialmessaging#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number in E.164 format for CALL-type buttons.

" + } + }, + "url": { + "target": "com.amazonaws.socialmessaging#MetaUrl", + "traits": { + "smithy.api#documentation": "

The URL for URL-type buttons.

" + } + }, + "otpType": { + "target": "com.amazonaws.socialmessaging#OtpType", + "traits": { + "smithy.api#documentation": "

The type of one-time password for OTP buttons.

" + } + }, + "zeroTapTermsAccepted": { + "target": "com.amazonaws.socialmessaging#ZeroTapTermsAccepted", + "traits": { + "smithy.api#documentation": "

When true, indicates acceptance of zero-tap terms for the button.

" + } + }, + "supportedApps": { + "target": "com.amazonaws.socialmessaging#SupportedApps", + "traits": { + "smithy.api#documentation": "

List of supported applications for this button type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a button in a template from Meta's library.

" + } + }, + "com.amazonaws.socialmessaging#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.socialmessaging#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied because it would exceed one or more service quotas or limits.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "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.

" + } + }, + "wabaId": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the WhatsApp Business Account ID.

" + } + } + }, + "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#GetWhatsAppMessageMediaInput": { + "com.amazonaws.socialmessaging#ListTagsForResourceInput": { "type": "structure", "members": { - "mediaId": { - "target": "com.amazonaws.socialmessaging#WhatsAppMediaId", + "resourceArn": { + "target": "com.amazonaws.socialmessaging#Arn", "traits": { - "smithy.api#documentation": "

The unique identifier for the media file.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to retrieve the tags from.

", + "smithy.api#httpQuery": "resourceArn", "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": { + "com.amazonaws.socialmessaging#ListTagsForResourceOutput": { "type": "structure", "members": { - "mimeType": { - "target": "smithy.api#String", + "statusCode": { + "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The MIME type of the media.

" + "smithy.api#documentation": "

The status code of the response.

" } }, - "fileSize": { - "target": "smithy.api#Long", + "tags": { + "target": "com.amazonaws.socialmessaging#TagList", "traits": { - "smithy.api#documentation": "

The file size of the media, in KB.

" + "smithy.api#documentation": "

The tags for the resource.

" } } }, @@ -510,490 +1564,522 @@ "smithy.api#output": {} } }, - "com.amazonaws.socialmessaging#Headers": { - "type": "map", - "key": { - "target": "smithy.api#String" + "com.amazonaws.socialmessaging#ListWhatsAppMessageTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#ListWhatsAppMessageTemplatesInput" }, - "value": { - "target": "smithy.api#String" + "output": { + "target": "com.amazonaws.socialmessaging#ListWhatsAppMessageTemplatesOutput" + }, + "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": "

Lists WhatsApp message templates for a specific WhatsApp Business Account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/whatsapp/template/list", + "code": 200 + }, + "smithy.api#paginated": { + "items": "templates" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.socialmessaging#InternalServiceException": { + "com.amazonaws.socialmessaging#ListWhatsAppMessageTemplatesInput": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.socialmessaging#ErrorMessage" + "id": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the WhatsApp Business Account to list templates for.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.socialmessaging#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.socialmessaging#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page (1-100).

", + "smithy.api#httpQuery": "maxResults" + } } }, "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": {} + "smithy.api#input": {} } }, - "com.amazonaws.socialmessaging#InvalidParametersException": { + "com.amazonaws.socialmessaging#ListWhatsAppMessageTemplatesOutput": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.socialmessaging#ErrorMessage" + "templates": { + "target": "com.amazonaws.socialmessaging#TemplateSummaryList", + "traits": { + "smithy.api#documentation": "

A list of template summaries.

" + } + }, + "nextToken": { + "target": "com.amazonaws.socialmessaging#NextToken", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next page of results, if any.

" + } } }, "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}$" + "smithy.api#output": {} } }, - "com.amazonaws.socialmessaging#LinkedAccountWithIncompleteSetup": { - "type": "map", - "key": { - "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountId" + "com.amazonaws.socialmessaging#ListWhatsAppTemplateLibrary": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#ListWhatsAppTemplateLibraryInput" }, - "value": { - "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountIdMetaData" + "output": { + "target": "com.amazonaws.socialmessaging#ListWhatsAppTemplateLibraryOutput" + }, + "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": "

Lists templates available in Meta's template library for WhatsApp messaging.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/whatsapp/template/library", + "code": 200 + }, + "smithy.api#paginated": { + "items": "metaLibraryTemplates" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccount": { + "com.amazonaws.socialmessaging#ListWhatsAppTemplateLibraryInput": { "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", + "nextToken": { + "target": "com.amazonaws.socialmessaging#NextToken", "traits": { - "smithy.api#documentation": "

The WhatsApp Business Account ID from meta.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The token for the next page of results.

" } }, - "registrationStatus": { - "target": "com.amazonaws.socialmessaging#RegistrationStatus", + "maxResults": { + "target": "com.amazonaws.socialmessaging#MaxResults", "traits": { - "smithy.api#documentation": "

The registration status of the linked WhatsApp Business Account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of results to return per page (1-100).

" } }, - "linkDate": { - "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountLinkDate", + "id": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", "traits": { - "smithy.api#documentation": "

The date the WhatsApp Business Account was linked.

", + "smithy.api#documentation": "

The ID of the WhatsApp Business Account to list library templates for.

", + "smithy.api#httpQuery": "id", "smithy.api#required": {} } }, - "wabaName": { - "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountName", + "filters": { + "target": "com.amazonaws.socialmessaging#Filter", "traits": { - "smithy.api#documentation": "

The name of the linked WhatsApp Business Account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Map of filters to apply (searchKey, topic, usecase, industry, language).

" } - }, - "eventDestinations": { - "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestinations", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#ListWhatsAppTemplateLibraryOutput": { + "type": "structure", + "members": { + "metaLibraryTemplates": { + "target": "com.amazonaws.socialmessaging#MetaLibraryTemplatesList", "traits": { - "smithy.api#documentation": "

The event destinations for the linked WhatsApp Business Account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of templates from Meta's library.

" } }, - "phoneNumbers": { - "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberSummaryList", + "nextToken": { + "target": "com.amazonaws.socialmessaging#NextToken", "traits": { - "smithy.api#documentation": "

The phone numbers associated with the Linked WhatsApp Business Account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The token to retrieve the next page of results, if any.

" } } }, "traits": { - "smithy.api#documentation": "

The details of your linked WhatsApp Business Account.

" + "smithy.api#output": {} } }, - "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountArn": { - "type": "string", + "com.amazonaws.socialmessaging#MaxResults": { + "type": "integer", "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:.*:waba/[0-9a-zA-Z]+$" + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.socialmessaging#MetaIndustries": { + "type": "list", + "member": { + "target": "com.amazonaws.socialmessaging#MetaIndustry" } }, - "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId": { + "com.amazonaws.socialmessaging#MetaIndustry": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 100 - }, - "smithy.api#pattern": "(^waba-.*$)|(^arn:.*:waba/[0-9a-zA-Z]+$)" + "max": 25 + } } }, - "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountIdMetaData": { + "com.amazonaws.socialmessaging#MetaLibraryTemplate": { "type": "structure", "members": { - "accountName": { - "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountName", + "templateName": { + "target": "com.amazonaws.socialmessaging#MetaTemplateName", "traits": { - "smithy.api#documentation": "

The name of your account.

" + "smithy.api#documentation": "

The name to assign to the template.

", + "smithy.api#required": {} } }, - "registrationStatus": { - "target": "com.amazonaws.socialmessaging#RegistrationStatus", + "libraryTemplateName": { + "target": "com.amazonaws.socialmessaging#MetaTemplateName", "traits": { - "smithy.api#documentation": "

The registration status of the linked WhatsApp Business Account.

" + "smithy.api#documentation": "

The name of the template in Meta's library.

", + "smithy.api#required": {} } }, - "unregisteredWhatsAppPhoneNumbers": { - "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberDetailList", + "templateCategory": { + "target": "com.amazonaws.socialmessaging#MetaTemplateCategory", "traits": { - "smithy.api#documentation": "

The details for unregistered WhatsApp phone numbers.

" + "smithy.api#documentation": "

The category of the template (for example, UTILITY or MARKETING).

", + "smithy.api#required": {} } }, - "wabaId": { - "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "templateLanguage": { + "target": "com.amazonaws.socialmessaging#MetaTemplateLanguage", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the WhatsApp Business Account ID.

" + "smithy.api#documentation": "

The language code for the template (for example, en_US).

", + "smithy.api#required": {} + } + }, + "libraryTemplateButtonInputs": { + "target": "com.amazonaws.socialmessaging#MetaLibraryTemplateButtonInputs", + "traits": { + "smithy.api#documentation": "

Button customizations for the template.

" + } + }, + "libraryTemplateBodyInputs": { + "target": "com.amazonaws.socialmessaging#LibraryTemplateBodyInputs", + "traits": { + "smithy.api#documentation": "

Body text customizations for the template.

" } } }, "traits": { - "smithy.api#documentation": "

Contains your WhatsApp registration status and details of any unregistered WhatsApp\n phone number.

" + "smithy.api#documentation": "

Represents a template from Meta's library with customization options.

" } }, - "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#MetaLibraryTemplateButtonInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.socialmessaging#LibraryTemplateButtonInput" } }, - "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountSummary": { + "com.amazonaws.socialmessaging#MetaLibraryTemplateButtonList": { + "type": "list", + "member": { + "target": "com.amazonaws.socialmessaging#LibraryTemplateButtonList" + } + }, + "com.amazonaws.socialmessaging#MetaLibraryTemplateDefinition": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountArn", + "templateName": { + "target": "com.amazonaws.socialmessaging#MetaTemplateName", "traits": { - "smithy.api#documentation": "

The ARN of the linked WhatsApp Business Account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the template.

" } }, - "id": { - "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "templateLanguage": { + "target": "com.amazonaws.socialmessaging#MetaTemplateLanguage", "traits": { - "smithy.api#documentation": "

The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The language code for the template (for example, en_US).

" } }, - "wabaId": { - "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountId", + "templateCategory": { + "target": "com.amazonaws.socialmessaging#MetaTemplateCategory", "traits": { - "smithy.api#documentation": "

The WhatsApp Business Account ID provided by Meta.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The category of the template (for example, UTILITY or MARKETING).

" } }, - "registrationStatus": { - "target": "com.amazonaws.socialmessaging#RegistrationStatus", + "templateTopic": { + "target": "com.amazonaws.socialmessaging#MetaTemplateTopic", "traits": { - "smithy.api#documentation": "

The registration status of the linked WhatsApp Business Account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The topic or subject matter of the template.

" } }, - "linkDate": { - "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountLinkDate", + "templateUseCase": { + "target": "com.amazonaws.socialmessaging#MetaTemplateUseCase", "traits": { - "smithy.api#documentation": "

The date the WhatsApp Business Account was linked.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The intended use case for the template.

" } }, - "wabaName": { - "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountName", + "templateIndustry": { + "target": "com.amazonaws.socialmessaging#MetaIndustries", "traits": { - "smithy.api#documentation": "

The name of the linked WhatsApp Business Account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The industries the template is designed for.

" } }, - "eventDestinations": { - "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestinations", + "templateHeader": { + "target": "com.amazonaws.socialmessaging#MetaTemplateHeader", "traits": { - "smithy.api#documentation": "

The event destinations for the linked WhatsApp Business Account.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The header text of the template.

" + } + }, + "templateBody": { + "target": "com.amazonaws.socialmessaging#MetaTemplateBody", + "traits": { + "smithy.api#documentation": "

The body text of the template.

" + } + }, + "templateButtons": { + "target": "com.amazonaws.socialmessaging#MetaLibraryTemplateButtonList", + "traits": { + "smithy.api#documentation": "

The buttons included in the template.

" + } + }, + "templateId": { + "target": "com.amazonaws.socialmessaging#MetaTemplateId", + "traits": { + "smithy.api#documentation": "

The ID of the template in Meta's library.

" } } }, "traits": { - "smithy.api#documentation": "

The details of a linked WhatsApp Business Account.

" + "smithy.api#documentation": "

Defines the complete structure and content of a template in Meta's library.

" } }, - "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountSummaryList": { + "com.amazonaws.socialmessaging#MetaLibraryTemplatesList": { "type": "list", "member": { - "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountSummary" + "target": "com.amazonaws.socialmessaging#MetaLibraryTemplateDefinition" } }, - "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberArn": { + "com.amazonaws.socialmessaging#MetaTemplate": { "type": "string", "traits": { "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:.*:phone-number-id/[0-9a-zA-Z]+$" + "min": 1, + "max": 6000 + } } }, - "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberResource": { - "type": "resource", - "identifiers": { - "OriginationPhoneNumberId": { - "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId" + "com.amazonaws.socialmessaging#MetaTemplateBody": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 } - }, - "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" + } + }, + "com.amazonaws.socialmessaging#MetaTemplateCategory": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 } - ], + } + }, + "com.amazonaws.socialmessaging#MetaTemplateComponents": { + "type": "blob", "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" + "smithy.api#length": { + "min": 1, + "max": 3000 } } }, - "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" + "com.amazonaws.socialmessaging#MetaTemplateDefinition": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6000 } - ], + } + }, + "com.amazonaws.socialmessaging#MetaTemplateHeader": { + "type": "string", "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": {} + "smithy.api#length": { + "min": 1, + "max": 200 + } } }, - "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" - } + "com.amazonaws.socialmessaging#MetaTemplateId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 }, - "maxResults": { - "target": "com.amazonaws.socialmessaging#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" - } + "smithy.api#pattern": "^[0-9]+$" + } + }, + "com.amazonaws.socialmessaging#MetaTemplateLanguage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 } - }, + } + }, + "com.amazonaws.socialmessaging#MetaTemplateName": { + "type": "string", "traits": { - "smithy.api#input": {} + "smithy.api#length": { + "min": 1, + "max": 512 + } } }, - "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.

" - } + "com.amazonaws.socialmessaging#MetaTemplateQualityScore": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 } - }, + } + }, + "com.amazonaws.socialmessaging#MetaTemplateStatus": { + "type": "string", "traits": { - "smithy.api#output": {} + "smithy.api#length": { + "min": 1, + "max": 20 + } } }, - "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" + "com.amazonaws.socialmessaging#MetaTemplateTopic": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 } - ], + } + }, + "com.amazonaws.socialmessaging#MetaTemplateUseCase": { + "type": "string", "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" - } - } - ] + "smithy.api#length": { + "min": 1, + "max": 30 + } } }, - "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": {} - } + "com.amazonaws.socialmessaging#MetaText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 } - }, + } + }, + "com.amazonaws.socialmessaging#MetaUrl": { + "type": "string", "traits": { - "smithy.api#input": {} + "smithy.api#length": { + "min": 1, + "max": 400 + } } }, - "com.amazonaws.socialmessaging#ListTagsForResourceOutput": { - "type": "structure", - "members": { - "statusCode": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The status code of the response.

" + "com.amazonaws.socialmessaging#MetaUrlWithSuffixExample": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 } - }, - "tags": { - "target": "com.amazonaws.socialmessaging#TagList", - "traits": { - "smithy.api#documentation": "

The tags for the resource.

" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 400 } } }, "traits": { - "smithy.api#output": {} + "smithy.api#length": { + "min": 0, + "max": 10 + } } }, - "com.amazonaws.socialmessaging#MaxResults": { - "type": "integer", + "com.amazonaws.socialmessaging#NextToken": { + "type": "string", "traits": { - "smithy.api#range": { + "smithy.api#length": { "min": 1, - "max": 100 + "max": 600 } } }, - "com.amazonaws.socialmessaging#NextToken": { + "com.amazonaws.socialmessaging#OtpType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, - "max": 600 + "max": 25 } } }, @@ -1327,14 +2413,38 @@ "type": "service", "version": "2024-01-01", "operations": [ + { + "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplate" + }, + { + "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateFromLibrary" + }, + { + "target": "com.amazonaws.socialmessaging#CreateWhatsAppMessageTemplateMedia" + }, + { + "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageTemplate" + }, + { + "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageTemplate" + }, { "target": "com.amazonaws.socialmessaging#ListTagsForResource" }, + { + "target": "com.amazonaws.socialmessaging#ListWhatsAppMessageTemplates" + }, + { + "target": "com.amazonaws.socialmessaging#ListWhatsAppTemplateLibrary" + }, { "target": "com.amazonaws.socialmessaging#TagResource" }, { "target": "com.amazonaws.socialmessaging#UntagResource" + }, + { + "target": "com.amazonaws.socialmessaging#UpdateWhatsAppMessageTemplate" } ], "resources": [ @@ -2091,6 +3201,39 @@ "target": "smithy.api#String" } }, + "com.amazonaws.socialmessaging#SupportedApp": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.socialmessaging#SupportedApps": { + "type": "list", + "member": { + "target": "com.amazonaws.socialmessaging#SupportedApp" + } + }, "com.amazonaws.socialmessaging#Tag": { "type": "structure", "members": { @@ -2209,6 +3352,56 @@ "smithy.api#output": {} } }, + "com.amazonaws.socialmessaging#TemplateSummary": { + "type": "structure", + "members": { + "templateName": { + "target": "com.amazonaws.socialmessaging#MetaTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the template.

" + } + }, + "metaTemplateId": { + "target": "com.amazonaws.socialmessaging#MetaTemplateId", + "traits": { + "smithy.api#documentation": "

The numeric ID assigned to the template by Meta.

" + } + }, + "templateStatus": { + "target": "com.amazonaws.socialmessaging#MetaTemplateStatus", + "traits": { + "smithy.api#documentation": "

The current status of the template (for example, APPROVED, PENDING, or REJECTED).

" + } + }, + "templateQualityScore": { + "target": "com.amazonaws.socialmessaging#MetaTemplateQualityScore", + "traits": { + "smithy.api#documentation": "

The quality score assigned to the template by Meta.

" + } + }, + "templateLanguage": { + "target": "com.amazonaws.socialmessaging#MetaTemplateLanguage", + "traits": { + "smithy.api#documentation": "

The language code of the template (for example, en_US).

" + } + }, + "templateCategory": { + "target": "com.amazonaws.socialmessaging#MetaTemplateCategory", + "traits": { + "smithy.api#documentation": "

The category of the template (for example, UTILITY or MARKETING).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a summary of a WhatsApp message template's key attributes.

" + } + }, + "com.amazonaws.socialmessaging#TemplateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.socialmessaging#TemplateSummary" + } + }, "com.amazonaws.socialmessaging#ThrottledRequestException": { "type": "structure", "members": { @@ -2316,6 +3509,81 @@ "smithy.api#output": {} } }, + "com.amazonaws.socialmessaging#UpdateWhatsAppMessageTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#UpdateWhatsAppMessageTemplateInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#UpdateWhatsAppMessageTemplateOutput" + }, + "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": "

Updates an existing WhatsApp message template.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/whatsapp/template", + "code": 200 + } + } + }, + "com.amazonaws.socialmessaging#UpdateWhatsAppMessageTemplateInput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the WhatsApp Business Account associated with this template.

", + "smithy.api#required": {} + } + }, + "metaTemplateId": { + "target": "com.amazonaws.socialmessaging#MetaTemplateId", + "traits": { + "smithy.api#documentation": "

The numeric ID of the template assigned by Meta.

", + "smithy.api#required": {} + } + }, + "templateCategory": { + "target": "com.amazonaws.socialmessaging#MetaTemplateCategory", + "traits": { + "smithy.api#documentation": "

The new category for the template (for example, UTILITY or MARKETING).

" + } + }, + "templateComponents": { + "target": "com.amazonaws.socialmessaging#MetaTemplateComponents", + "traits": { + "smithy.api#documentation": "

The updated components of the template as a JSON blob (maximum 3000 characters).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#UpdateWhatsAppMessageTemplateOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.socialmessaging#ValidationException": { "type": "structure", "members": { @@ -2535,6 +3803,12 @@ "smithy.api#documentation": "

The quality rating of the phone number.

", "smithy.api#required": {} } + }, + "dataLocalizationRegion": { + "target": "com.amazonaws.socialmessaging#IsoCountryCode", + "traits": { + "smithy.api#documentation": "

The geographic region where the WhatsApp phone number's data is stored and processed.

" + } } }, "traits": { @@ -2624,6 +3898,12 @@ "smithy.api#documentation": "

The quality rating of the phone number. This is from Meta.

", "smithy.api#required": {} } + }, + "dataLocalizationRegion": { + "target": "com.amazonaws.socialmessaging#IsoCountryCode", + "traits": { + "smithy.api#documentation": "

The geographic region where the WhatsApp phone number's data is stored and processed.

" + } } }, "traits": { @@ -2682,6 +3962,15 @@ }, "smithy.api#required": {} } + }, + "callbackUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The URL where WhatsApp will send callback notifications for this account.

", + "smithy.api#length": { + "max": 100 + } + } } }, "traits": { @@ -2707,6 +3996,9 @@ "traits": { "smithy.api#documentation": "

Contains the results of WhatsAppSignupCallback.

" } + }, + "com.amazonaws.socialmessaging#ZeroTapTermsAccepted": { + "type": "boolean" } } } \ No newline at end of file diff --git a/codegen/sdk/aws-models/sqs.json b/codegen/sdk/aws-models/sqs.json index 737f3c4585b..21d8282d0bb 100644 --- a/codegen/sdk/aws-models/sqs.json +++ b/codegen/sdk/aws-models/sqs.json @@ -201,7 +201,7 @@ }, "aws.protocols#awsJson1_0": {}, "aws.protocols#awsQueryCompatible": {}, - "smithy.api#documentation": "

Welcome to the Amazon SQS API Reference.

\n

Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel\n between applications or microservices. Amazon SQS moves data between distributed application\n components and helps you decouple these components.

\n

For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n

\n

You can use Amazon Web Services SDKs to access\n Amazon SQS using your favorite programming language. The SDKs perform tasks such as the\n following automatically:

\n
    \n
  • \n

    Cryptographically sign your service requests

    \n
    • \n
  • \n

    Retry requests

    \n
    • \n
  • \n

    Handle error responses

    \n
    • \n
\n

\n Additional information\n

\n ", + "smithy.api#documentation": "

Welcome to the Amazon SQS API Reference.

\n

Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel\n between applications or microservices. Amazon SQS moves data between distributed application\n components and helps you decouple these components.

\n

For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n

\n

You can use Amazon Web Services SDKs to access\n Amazon SQS using your favorite programming language. The SDKs perform tasks such as the\n following automatically:

\n
    \n
  • \n

    Cryptographically sign your service requests

    \n
    • \n
  • \n

    Retry requests

    \n
    • \n
  • \n

    Handle error responses

    \n
    • \n
\n

\n Additional information\n

\n ", "smithy.api#title": "Amazon Simple Queue Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1618,7 +1618,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:

\n
    \n
  • \n

    If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.

    \n \n

    You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide.

    \n     \n
    • \n
  • \n

    If you don't provide a value for an attribute, the queue is created with the\n default value for the attribute.

    \n
    • \n
  • \n

    If you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name.

    \n
    • \n
\n

To successfully create a new queue, you must provide a queue name that adheres to the\n limits\n related to queues and is unique within the scope of your queues.

\n \n

After you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.

\n \n

To retrieve the URL of a queue, use the \n GetQueueUrl\n action. This action only requires the \n QueueName\n parameter.

\n

When creating queues, keep the following points in mind:

\n
    \n
  • \n

    If you specify the name of an existing queue and provide the exact same names\n and values for all its attributes, the \n CreateQueue\n action will return the URL of the\n existing queue instead of creating a new one.

    \n
    • \n
  • \n

    If you attempt to create a queue with a name that already exists but with\n different attribute names or values, the CreateQueue action will\n return an error. This ensures that existing queues are not inadvertently\n altered.

    \n
    • \n
\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n " + "smithy.api#documentation": "

Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:

\n
    \n
  • \n

    If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.

    \n \n

    You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a standard queue to a FIFO queue in the\n Amazon SQS Developer Guide.

    \n     \n
    • \n
  • \n

    If you don't provide a value for an attribute, the queue is created with the\n default value for the attribute.

    \n
    • \n
  • \n

    If you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name.

    \n
    • \n
\n

To successfully create a new queue, you must provide a queue name that adheres to the\n limits\n related to queues and is unique within the scope of your queues.

\n \n

After you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.

\n \n

To retrieve the URL of a queue, use the \n GetQueueUrl\n action. This action only requires the \n QueueName\n parameter.

\n

When creating queues, keep the following points in mind:

\n
    \n
  • \n

    If you specify the name of an existing queue and provide the exact same names\n and values for all its attributes, the \n CreateQueue\n action will return the URL of the\n existing queue instead of creating a new one.

    \n
    • \n
  • \n

    If you attempt to create a queue with a name that already exists but with\n different attribute names or values, the CreateQueue action will\n return an error. This ensures that existing queues are not inadvertently\n altered.

    \n
    • \n
\n \n

Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

\n " } }, "com.amazonaws.sqs#CreateQueueRequest": { @@ -3339,7 +3339,7 @@ "smithy.api#deprecated": { "message": "AttributeNames has been replaced by MessageSystemAttributeNames" }, - "smithy.api#documentation": "\n

This parameter has been discontinued but will be supported for backward\n compatibility. To provide attribute names, you are encouraged to use\n MessageSystemAttributeNames.

\n \n

A list of attributes that need to be returned along with each message. These\n attributes include:

\n
    \n
  • \n

    \n All – Returns all values.

    \n
    • \n
  • \n

    \n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).

    \n
    • \n
  • \n

    \n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.

    \n
    • \n
  • \n

    \n AWSTraceHeader – Returns the X-Ray trace\n header string.

    \n
    • \n
  • \n

    \n SenderId\n

    \n
      \n
    • \n

      For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.

      \n
      • \n
    • \n

      For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

      \n
      • \n
    \n
    • \n
  • \n

    \n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).

    \n
    • \n
  • \n

    \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

    \n
    • \n
  • \n

    \n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.

    \n
    • \n
  • \n

    \n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.\n Messages with the same MessageGroupId are returned in\n sequence.

    \n
    • \n
  • \n

    \n SequenceNumber – Returns the value provided by\n Amazon SQS.

    \n
    • \n
", + "smithy.api#documentation": "\n

This parameter has been discontinued but will be supported for backward\n compatibility. To provide attribute names, you are encouraged to use\n MessageSystemAttributeNames.

\n \n

A list of attributes that need to be returned along with each message. These\n attributes include:

\n
    \n
  • \n

    \n All – Returns all values.

    \n
    • \n
  • \n

    \n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).

    \n
    • \n
  • \n

    \n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.

    \n
    • \n
  • \n

    \n AWSTraceHeader – Returns the X-Ray trace\n header string.

    \n
    • \n
  • \n

    \n SenderId\n

    \n
      \n
    • \n

      For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.

      \n
      • \n
    • \n

      For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

      \n
      • \n
    \n
    • \n
  • \n

    \n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).

    \n
    • \n
  • \n

    \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

    \n
    • \n
  • \n

    \n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.

    \n
    • \n
  • \n

    \n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.\n

    \n
    • \n
  • \n

    \n SequenceNumber – Returns the value provided by\n Amazon SQS.

    \n
    • \n
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } @@ -3347,7 +3347,7 @@ "MessageSystemAttributeNames": { "target": "com.amazonaws.sqs#MessageSystemAttributeList", "traits": { - "smithy.api#documentation": "

A list of attributes that need to be returned along with each message. These\n attributes include:

\n
    \n
  • \n

    \n All – Returns all values.

    \n
    • \n
  • \n

    \n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).

    \n
    • \n
  • \n

    \n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.

    \n
    • \n
  • \n

    \n AWSTraceHeader – Returns the X-Ray trace\n header string.

    \n
    • \n
  • \n

    \n SenderId\n

    \n
      \n
    • \n

      For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.

      \n
      • \n
    • \n

      For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

      \n
      • \n
    \n
    • \n
  • \n

    \n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).

    \n
    • \n
  • \n

    \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

    \n
    • \n
  • \n

    \n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.

    \n
    • \n
  • \n

    \n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.\n Messages with the same MessageGroupId are returned in\n sequence.

    \n
    • \n
  • \n

    \n SequenceNumber – Returns the value provided by\n Amazon SQS.

    \n
    • \n
", + "smithy.api#documentation": "

A list of attributes that need to be returned along with each message. These\n attributes include:

\n
    \n
  • \n

    \n All – Returns all values.

    \n
    • \n
  • \n

    \n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).

    \n
    • \n
  • \n

    \n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.

    \n
    • \n
  • \n

    \n AWSTraceHeader – Returns the X-Ray trace\n header string.

    \n
    • \n
  • \n

    \n SenderId\n

    \n
      \n
    • \n

      For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.

      \n
      • \n
    • \n

      For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

      \n
      • \n
    \n
    • \n
  • \n

    \n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).

    \n
    • \n
  • \n

    \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

    \n
    • \n
  • \n

    \n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.

    \n
    • \n
  • \n

    \n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.

    \n
    • \n
  • \n

    \n SequenceNumber – Returns the value provided by\n Amazon SQS.

    \n
    • \n
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } @@ -3381,7 +3381,7 @@ "ReceiveRequestAttemptId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of ReceiveMessage calls. If a networking\n issue occurs after a ReceiveMessage action, and instead of a response you\n receive a generic error, it is possible to retry the same action with an identical\n ReceiveRequestAttemptId to retrieve the same set of messages, even if\n their visibility timeout has not yet expired.

\n
    \n
  • \n

    You can use ReceiveRequestAttemptId only for 5 minutes after a\n ReceiveMessage action.

    \n
    • \n
  • \n

    When you set FifoQueue, a caller of the\n ReceiveMessage action can provide a\n ReceiveRequestAttemptId explicitly.

    \n
    • \n
  • \n

    It is possible to retry the ReceiveMessage action with the same\n ReceiveRequestAttemptId if none of the messages have been\n modified (deleted or had their visibility changes).

    \n
    • \n
  • \n

    During a visibility timeout, subsequent calls with the same\n ReceiveRequestAttemptId return the same messages and receipt\n handles. If a retry occurs within the deduplication interval, it resets the\n visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.

    \n \n

    If a caller of the ReceiveMessage action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.

    \n

    To mitigate this effect, ensure that your application observes a safe\n threshold before the visibility timeout expires and extend the visibility\n timeout as necessary.

    \n     \n
    • \n
  • \n

    While messages with a particular MessageGroupId are invisible, no\n more messages belonging to the same MessageGroupId are returned\n until the visibility timeout expires. You can still receive messages with\n another MessageGroupId as long as it is also visible.

    \n
    • \n
  • \n

    If a caller of ReceiveMessage can't track the\n ReceiveRequestAttemptId, no retries work until the original\n visibility timeout expires. As a result, delays might occur but the messages in\n the queue remain in a strict order.

    \n
    • \n
\n

The maximum length of ReceiveRequestAttemptId is 128 characters.\n ReceiveRequestAttemptId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS\n Developer Guide.

" + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The token used for deduplication of ReceiveMessage calls. If a networking\n issue occurs after a ReceiveMessage action, and instead of a response you\n receive a generic error, it is possible to retry the same action with an identical\n ReceiveRequestAttemptId to retrieve the same set of messages, even if\n their visibility timeout has not yet expired.

\n
    \n
  • \n

    You can use ReceiveRequestAttemptId only for 5 minutes after a\n ReceiveMessage action.

    \n
    • \n
  • \n

    When you set FifoQueue, a caller of the\n ReceiveMessage action can provide a\n ReceiveRequestAttemptId explicitly.

    \n
    • \n
  • \n

    It is possible to retry the ReceiveMessage action with the same\n ReceiveRequestAttemptId if none of the messages have been\n modified (deleted or had their visibility changes).

    \n
    • \n
  • \n

    During a visibility timeout, subsequent calls with the same\n ReceiveRequestAttemptId return the same messages and receipt\n handles. If a retry occurs within the deduplication interval, it resets the\n visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.

    \n \n

    If a caller of the ReceiveMessage action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.

    \n

    To mitigate this effect, ensure that your application observes a safe\n threshold before the visibility timeout expires and extend the visibility\n timeout as necessary.

    \n     \n
    • \n
  • \n

    While messages with a particular MessageGroupId are invisible, \n no more messages belonging to the same MessageGroupId are returned \n until the visibility timeout expires. You can still receive messages \n with another MessageGroupId from your FIFO queue as long as they are visible.

    \n
    • \n
  • \n

    If a caller of ReceiveMessage can't track the\n ReceiveRequestAttemptId, no retries work until the original\n visibility timeout expires. As a result, delays might occur but the messages in\n the queue remain in a strict order.

    \n
    • \n
\n

The maximum length of ReceiveRequestAttemptId is 128 characters.\n ReceiveRequestAttemptId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS\n Developer Guide.

" } } }, @@ -3543,7 +3543,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delivers a message to the specified queue.

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

\n " + "smithy.api#documentation": "

Delivers a message to the specified queue.

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

\n " } }, "com.amazonaws.sqs#SendMessageBatch": { @@ -3608,7 +3608,7 @@ } ], "traits": { - "smithy.api#documentation": "

You can use SendMessageBatch to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.

\n

The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

\n

The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes).

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

\n \n

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses\n the default value for the queue.

" + "smithy.api#documentation": "

You can use SendMessageBatch to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.

\n

The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

\n

The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes).

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

\n \n

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses\n the default value for the queue.

" } }, "com.amazonaws.sqs#SendMessageBatchRequest": { @@ -3684,7 +3684,7 @@ "MessageGroupId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.

\n
    \n
  • \n

    You must associate a non-empty MessageGroupId with a message. If\n you don't provide a MessageGroupId, the action fails.

    \n
    • \n
  • \n

    \n ReceiveMessage might return messages with multiple\n MessageGroupId values. For each MessageGroupId,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId.

    \n
    • \n
\n

The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.

\n \n

\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.

\n " + "smithy.api#documentation": "

\n MessageGroupId is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues. \n In FIFO queues, MessageGroupId organizes messages into distinct groups. \n Messages within the same message group are always processed one at a time, in strict order, \n ensuring that no two messages from the same group are processed simultaneously. \n In standard queues, using MessageGroupId enables fair queues. \n It is used to identify the tenant a message belongs to, \n helping maintain consistent message dwell time across all tenants during noisy neighbor events. \n Unlike FIFO queues, messages with the same MessageGroupId can be processed in parallel, \n maintaining the high throughput of standard queues.

\n
    \n
  • \n

    \n FIFO queues:\n MessageGroupId acts as the tag \n that specifies that a message belongs to a specific message group. \n Messages that belong to the same message group are processed in a FIFO manner \n (however, messages in different message groups might be processed out of order). \n To interleave multiple ordered streams within a single queue, use MessageGroupId values \n (for example, session data for multiple users). \n In this scenario, multiple consumers can process the queue, \n but the session data of each user is processed in a FIFO fashion.

    \n

    If you do not provide a MessageGroupId when sending a message to a FIFO queue, the action fails.

    \n

    \n ReceiveMessage might return messages with multiple MessageGroupId values. \n For each MessageGroupId, the messages are sorted by time sent.

    \n
    • \n
  • \n

    \n Standard queues:Use MessageGroupId in standard queues to enable fair queues. \n The MessageGroupId identifies the tenant a message belongs to. \n A tenant can be any entity that shares a queue with others, such as your customer, a client application, \n or a request type. When one tenant sends a disproportionately large volume of messages \n or has messages that require longer processing time, fair queues ensure other tenants' \n messages maintain low dwell time. This preserves quality of service for all tenants while \n maintaining the scalability and throughput of standard queues. \n We recommend that you include a MessageGroupId in all messages when using fair queues.

    \n
    • \n
\n

The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.

" } } }, @@ -3791,7 +3791,7 @@ "MessageBody": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

The message to send. The minimum size is one character. The maximum size is 256\n KiB.

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

\n ", + "smithy.api#documentation": "

The message to send. The minimum size is one character. The maximum size is 256\n KiB.

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

\n ", "smithy.api#required": {} } }, @@ -3826,7 +3826,7 @@ "MessageGroupId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) queues.

\n

The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.

\n
    \n
  • \n

    You must associate a non-empty MessageGroupId with a message. If\n you don't provide a MessageGroupId, the action fails.

    \n
    • \n
  • \n

    \n ReceiveMessage might return messages with multiple\n MessageGroupId values. For each MessageGroupId,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId.

    \n
    • \n
\n

The maximum length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.

\n \n

\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.

\n " + "smithy.api#documentation": "

\n MessageGroupId is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues. \n In FIFO queues, MessageGroupId organizes messages into distinct groups. \n Messages within the same message group are always processed one at a time, in strict order, \n ensuring that no two messages from the same group are processed simultaneously. \n In standard queues, using MessageGroupId enables fair queues. \n It is used to identify the tenant a message belongs to, \n helping maintain consistent message dwell time across all tenants during noisy neighbor events. \n Unlike FIFO queues, messages with the same MessageGroupId can be processed in parallel, \n maintaining the high throughput of standard queues.

\n
    \n
  • \n

    \n FIFO queues:\n MessageGroupId acts as the tag \n that specifies that a message belongs to a specific message group. \n Messages that belong to the same message group are processed in a FIFO manner \n (however, messages in different message groups might be processed out of order). \n To interleave multiple ordered streams within a single queue, use MessageGroupId values \n (for example, session data for multiple users). \n In this scenario, multiple consumers can process the queue, \n but the session data of each user is processed in a FIFO fashion.

    \n

    If you do not provide a MessageGroupId when sending a message to a FIFO queue, the action fails.

    \n

    \n ReceiveMessage might return messages with multiple MessageGroupId values. \n For each MessageGroupId, the messages are sorted by time sent.

    \n
    • \n
  • \n

    \n Standard queues:Use MessageGroupId in standard queues to enable fair queues. \n The MessageGroupId identifies the tenant a message belongs to. \n A tenant can be any entity that shares a queue with others, such as your customer, a client application, \n or a request type. When one tenant sends a disproportionately large volume of messages \n or has messages that require longer processing time, fair queues ensure other tenants' \n messages maintain low dwell time. This preserves quality of service for all tenants while \n maintaining the scalability and throughput of standard queues. \n We recommend that you include a MessageGroupId in all messages when using fair queues.

    \n
    • \n
\n

The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.

" } } }, diff --git a/codegen/sdk/aws-models/ssm.json b/codegen/sdk/aws-models/ssm.json index aac24c4efb9..b29405f9a26 100644 --- a/codegen/sdk/aws-models/ssm.json +++ b/codegen/sdk/aws-models/ssm.json @@ -949,7 +949,7 @@ "name": "ssm" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure\n end-to-end management solution for hybrid cloud environments that enables safe and secure\n operations at scale.

\n

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up\n Amazon Web Services Systems Manager.

\n

\n Related resources\n

\n ", + "smithy.api#documentation": "

Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure\n end-to-end management solution for hybrid cloud environments that enables safe and secure\n operations at scale.

\n

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up\n Amazon Web Services Systems Manager.

\n

\n Related resources\n

\n ", "smithy.api#title": "Amazon Simple Systems Manager (SSM)", "smithy.api#xmlNamespace": { "uri": "http://ssm.amazonaws.com/doc/2014-11-06/" @@ -5328,7 +5328,7 @@ "ExecutionTime": { "target": "com.amazonaws.ssm#DateTime", "traits": { - "smithy.api#documentation": "

The time the execution ran as a datetime object that is saved in the following format:\n yyyy-MM-dd'T'HH:mm:ss'Z'\n

", + "smithy.api#documentation": "

The time the execution ran as a datetime object that is saved in the following format:\n yyyy-MM-dd'T'HH:mm:ss'Z'\n

\n \n

For State Manager associations, this timestamp represents when the compliance status was\n captured and reported by the Systems Manager service, not when the underlying association was actually\n executed on the managed node. To track actual association execution times, use the DescribeAssociationExecutionTargets command or check the association execution\n history in the Systems Manager console.

\n ", "smithy.api#required": {} } }, @@ -5409,7 +5409,7 @@ "ExecutionSummary": { "target": "com.amazonaws.ssm#ComplianceExecutionSummary", "traits": { - "smithy.api#documentation": "

A summary for the compliance item. The summary includes an execution ID, the execution type\n (for example, command), and the execution time.

" + "smithy.api#documentation": "

A summary for the compliance item. The summary includes an execution ID, the execution type\n (for example, command), and the execution time.

\n \n

For State Manager associations, the ExecutionTime value represents when the\n compliance status was captured and aggregated by the Systems Manager service, not necessarily when the\n underlying association was executed on the managed node. State Manager updates compliance status\n for all associations on an instance whenever any association executes, which means multiple\n associations may show the same execution time even if they were executed at different\n times.

\n " } }, "Details": { @@ -10244,7 +10244,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable\n the Shared option.

\n

Request results are returned on a best-effort basis. If you specify MaxResults\n in the request, the response includes information up to the limit specified. The number of items\n returned, however, can be between zero and the value of MaxResults. If the service\n reaches an internal limit while processing the results, it stops the operation and returns the\n matching values up to that point and a NextToken. You can specify the\n NextToken in a subsequent call to get the next set of results.

\n \n

If you change the KMS key alias for the KMS key used to encrypt a parameter,\n then you must also update the key alias the parameter uses to reference KMS. Otherwise,\n DescribeParameters retrieves whatever the original key alias was\n referencing.

\n ", + "smithy.api#documentation": "

Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable\n the Shared option.

\n

Request results are returned on a best-effort basis. If you specify MaxResults\n in the request, the response includes information up to the limit specified. The number of items\n returned, however, can be between zero and the value of MaxResults. If the service\n reaches an internal limit while processing the results, it stops the operation and returns the\n matching values up to that point and a NextToken. You can specify the\n NextToken in a subsequent call to get the next set of results.

\n

Parameter names can't contain spaces. The service removes any spaces specified for the\n beginning or end of a parameter name. If the specified name for a parameter contains spaces\n between characters, the request fails with a ValidationException error.

\n \n

If you change the KMS key alias for the KMS key used to encrypt a parameter,\n then you must also update the key alias the parameter uses to reference KMS. Otherwise,\n DescribeParameters retrieves whatever the original key alias was\n referencing.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -14260,7 +14260,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get information about a single parameter by specifying the parameter name.

\n \n

To get information about more than one parameter at a time, use the GetParameters operation.

\n " + "smithy.api#documentation": "

Get information about a single parameter by specifying the parameter name.

\n

Parameter names can't contain spaces. The service removes any spaces specified for the\n beginning or end of a parameter name. If the specified name for a parameter contains spaces\n between characters, the request fails with a ValidationException error.

\n \n

To get information about more than one parameter at a time, use the GetParameters operation.

\n " } }, "com.amazonaws.ssm#GetParameterHistory": { @@ -14286,7 +14286,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the history of all changes to a parameter.

\n \n

If you change the KMS key alias for the KMS key used to encrypt a parameter,\n then you must also update the key alias the parameter uses to reference KMS. Otherwise,\n GetParameterHistory retrieves whatever the original key alias was\n referencing.

\n ", + "smithy.api#documentation": "

Retrieves the history of all changes to a parameter.

\n

Parameter names can't contain spaces. The service removes any spaces specified for the\n beginning or end of a parameter name. If the specified name for a parameter contains spaces\n between characters, the request fails with a ValidationException error.

\n \n

If you change the KMS key alias for the KMS key used to encrypt a parameter,\n then you must also update the key alias the parameter uses to reference KMS. Otherwise,\n GetParameterHistory retrieves whatever the original key alias was\n referencing.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -14401,7 +14401,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get information about one or more parameters by specifying multiple parameter names.

\n \n

To get information about a single parameter, you can use the GetParameter\n operation instead.

\n " + "smithy.api#documentation": "

Get information about one or more parameters by specifying multiple parameter names.

\n \n

To get information about a single parameter, you can use the GetParameter\n operation instead.

\n \n

Parameter names can't contain spaces. The service removes any spaces specified for the\n beginning or end of a parameter name. If the specified name for a parameter contains spaces\n between characters, the request fails with a ValidationException error.

" } }, "com.amazonaws.ssm#GetParametersByPath": { @@ -14433,7 +14433,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieve information about one or more parameters under a specified level in a hierarchy.

\n

Request results are returned on a best-effort basis. If you specify MaxResults\n in the request, the response includes information up to the limit specified. The number of items\n returned, however, can be between zero and the value of MaxResults. If the service\n reaches an internal limit while processing the results, it stops the operation and returns the\n matching values up to that point and a NextToken. You can specify the\n NextToken in a subsequent call to get the next set of results.

", + "smithy.api#documentation": "

Retrieve information about one or more parameters under a specified level in a hierarchy.

\n

Request results are returned on a best-effort basis. If you specify MaxResults\n in the request, the response includes information up to the limit specified. The number of items\n returned, however, can be between zero and the value of MaxResults. If the service\n reaches an internal limit while processing the results, it stops the operation and returns the\n matching values up to that point and a NextToken. You can specify the\n NextToken in a subsequent call to get the next set of results.

\n

Parameter names can't contain spaces. The service removes any spaces specified for the\n beginning or end of a parameter name. If the specified name for a parameter contains spaces\n between characters, the request fails with a ValidationException error.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -17390,7 +17390,7 @@ "Values": { "target": "com.amazonaws.ssm#InventoryFilterValueList", "traits": { - "smithy.api#documentation": "

Inventory filter values. Example: inventory filter where managed node IDs are specified as\n values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g,\n i-1a2b3c4d5e6,Type=Equal.

", + "smithy.api#documentation": "

Inventory filter values.

", "smithy.api#required": {} } }, @@ -17402,7 +17402,7 @@ } }, "traits": { - "smithy.api#documentation": "

One or more filters. Use a filter to return a more specific list of results.

" + "smithy.api#documentation": "

One or more filters. Use a filter to return a more specific list of results.

\n

\n Example formats for the aws ssm get-inventory\n command:\n

\n

\n --filters\n Key=AWS:InstanceInformation.AgentType,Values=amazon-ssm-agent,Type=Equal\n

\n

\n --filters\n Key=AWS:InstanceInformation.AgentVersion,Values=3.3.2299.0,Type=Equal\n

\n

\n --filters\n Key=AWS:InstanceInformation.ComputerName,Values=ip-192.0.2.0.us-east-2.compute.internal,Type=Equal\n

\n

\n --filters\n Key=AWS:InstanceInformation.InstanceId,Values=i-0a4cd6ceffEXAMPLE,i-1a2b3c4d5e6EXAMPLE,Type=Equal\n

\n

\n --filters\n Key=AWS:InstanceInformation.InstanceStatus,Values=Active,Type=Equal\n

\n

\n --filters\n Key=AWS:InstanceInformation.IpAddress,Values=198.51.100.0,Type=Equal\n

\n

\n --filters Key=AWS:InstanceInformation.PlatformName,Values=\"Amazon\n Linux\",Type=Equal\n

\n

\n --filters\n Key=AWS:InstanceInformation.PlatformType,Values=Linux,Type=Equal\n

\n

\n --filters\n Key=AWS:InstanceInformation.PlatformVersion,Values=2023,Type=BeginWith\n

\n

\n --filters\n Key=AWS:InstanceInformation.ResourceType,Values=EC2Instance,Type=Equal\n

" } }, "com.amazonaws.ssm#InventoryFilterKey": { @@ -17969,7 +17969,7 @@ } ], "traits": { - "smithy.api#documentation": "

A parameter label is a user-defined alias to help you manage different versions of a\n parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and\n increments the version number by one. A label can help you remember the purpose of a parameter\n when there are multiple versions.

\n

Parameter labels have the following requirements and restrictions.

\n
    \n
  • \n

    A version of a parameter can have a maximum of 10 labels.

    \n
    • \n
  • \n

    You can't attach the same label to different versions of the same parameter. For example,\n if version 1 has the label Production, then you can't attach Production to version 2.

    \n
    • \n
  • \n

    You can move a label from one version of a parameter to another.

    \n
    • \n
  • \n

    You can't create a label when you create a new parameter. You must attach a label to a\n specific version of a parameter.

    \n
    • \n
  • \n

    If you no longer want to use a parameter label, then you can either delete it or move it\n to a different version of a parameter.

    \n
    • \n
  • \n

    A label can have a maximum of 100 characters.

    \n
    • \n
  • \n

    Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or\n underscores (_).

    \n
    • \n
  • \n

    Labels can't begin with a number, \"aws\" or \"ssm\" (not case\n sensitive). If a label fails to meet these requirements, then the label isn't associated with a\n parameter and the system displays it in the list of InvalidLabels.

    \n
    • \n
" + "smithy.api#documentation": "

A parameter label is a user-defined alias to help you manage different versions of a\n parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and\n increments the version number by one. A label can help you remember the purpose of a parameter\n when there are multiple versions.

\n

Parameter labels have the following requirements and restrictions.

\n
    \n
  • \n

    A version of a parameter can have a maximum of 10 labels.

    \n
    • \n
  • \n

    You can't attach the same label to different versions of the same parameter. For example,\n if version 1 has the label Production, then you can't attach Production to version 2.

    \n
    • \n
  • \n

    You can move a label from one version of a parameter to another.

    \n
    • \n
  • \n

    You can't create a label when you create a new parameter. You must attach a label to a\n specific version of a parameter.

    \n
    • \n
  • \n

    If you no longer want to use a parameter label, then you can either delete it or move it\n to a different version of a parameter.

    \n
    • \n
  • \n

    A label can have a maximum of 100 characters.

    \n
    • \n
  • \n

    Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or\n underscores (_).

    \n
    • \n
  • \n

    Labels can't begin with a number, \"aws\" or \"ssm\" (not case\n sensitive). If a label fails to meet these requirements, then the label isn't associated with a\n parameter and the system displays it in the list of InvalidLabels.

    \n
    • \n
  • \n

    Parameter names can't contain spaces. The service removes any spaces specified for\n the beginning or end of a parameter name. If the specified name for a parameter contains spaces\n between characters, the request fails with a ValidationException error.

    \n
    • \n
" } }, "com.amazonaws.ssm#LabelParameterVersionRequest": { @@ -25507,7 +25507,7 @@ "Configuration": { "target": "com.amazonaws.ssm#PatchSourceConfiguration", "traits": { - "smithy.api#documentation": "

The value of the yum repo configuration. For example:

\n

\n [main]\n

\n

\n name=MyCustomRepository\n

\n

\n baseurl=https://my-custom-repository\n

\n

\n enabled=1\n

\n \n

For information about other options available for your yum repository configuration, see\n dnf.conf(5).

\n ", + "smithy.api#documentation": "

The value of the repo configuration.

\n

\n Example for yum repositories\n

\n

\n [main]\n

\n

\n name=MyCustomRepository\n

\n

\n baseurl=https://my-custom-repository\n

\n

\n enabled=1\n

\n

For information about other options available for your yum repository configuration, see\n dnf.conf(5) on the\n man7.org website.

\n

\n Examples for Ubuntu Server and Debian Server\n

\n

\n deb http://security.ubuntu.com/ubuntu jammy main\n

\n

\n deb https://site.example.com/debian distribution component1 component2 component3\n

\n

Repo information for Ubuntu Server repositories must be specifed in a single line. For more\n examples and information, see jammy (5)\n sources.list.5.gz on the Ubuntu Server Manuals website and sources.list format on the\n Debian Wiki.

", "smithy.api#required": {} } } @@ -25794,7 +25794,7 @@ } ], "traits": { - "smithy.api#documentation": "

Registers a compliance type and other compliance details on a designated resource. This\n operation lets you register custom compliance details with a resource. This call overwrites\n existing compliance information on the resource, so you must provide a full list of compliance\n items each time that you send the request.

\n

ComplianceType can be one of the following:

\n
    \n
  • \n

    ExecutionId: The execution ID when the patch, association, or custom compliance item was\n applied.

    \n
    • \n
  • \n

    ExecutionType: Specify patch, association, or Custom:string.

    \n
    • \n
  • \n

    ExecutionTime. The time the patch, association, or custom compliance item was applied to\n the managed node.

    \n
    • \n
  • \n

    Id: The patch, association, or custom compliance ID.

    \n
    • \n
  • \n

    Title: A title.

    \n
    • \n
  • \n

    Status: The status of the compliance item. For example, approved for patches,\n or Failed for associations.

    \n
    • \n
  • \n

    Severity: A patch severity. For example, Critical.

    \n
    • \n
  • \n

    DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.

    \n
    • \n
  • \n

    DocumentVersion: An SSM document version number. For example, 4.

    \n
    • \n
  • \n

    Classification: A patch classification. For example, security updates.

    \n
    • \n
  • \n

    PatchBaselineId: A patch baseline ID.

    \n
    • \n
  • \n

    PatchSeverity: A patch severity. For example, Critical.

    \n
    • \n
  • \n

    PatchState: A patch state. For example, InstancesWithFailedPatches.

    \n
    • \n
  • \n

    PatchGroup: The name of a patch group.

    \n
    • \n
  • \n

    InstalledTime: The time the association, patch, or custom compliance item was applied to\n the resource. Specify the time by using the following format:\n yyyy-MM-dd'T'HH:mm:ss'Z'\n

    \n
    • \n
" + "smithy.api#documentation": "

Registers a compliance type and other compliance details on a designated resource. This\n operation lets you register custom compliance details with a resource. This call overwrites\n existing compliance information on the resource, so you must provide a full list of compliance\n items each time that you send the request.

\n

ComplianceType can be one of the following:

\n
    \n
  • \n

    ExecutionId: The execution ID when the patch, association, or custom compliance item was\n applied.

    \n
    • \n
  • \n

    ExecutionType: Specify patch, association, or Custom:string.

    \n
    • \n
  • \n

    ExecutionTime. The time the patch, association, or custom compliance item was applied to\n the managed node.

    \n \n

    For State Manager associations, this represents the time when compliance status was\n captured by the Systems Manager service during its internal compliance aggregation workflow, not\n necessarily when the association was executed on the managed node. State Manager updates\n compliance information for all associations on an instance whenever any association executes,\n which may result in multiple associations showing the same execution time.

    \n     \n
    • \n
  • \n

    Id: The patch, association, or custom compliance ID.

    \n
    • \n
  • \n

    Title: A title.

    \n
    • \n
  • \n

    Status: The status of the compliance item. For example, approved for patches,\n or Failed for associations.

    \n
    • \n
  • \n

    Severity: A patch severity. For example, Critical.

    \n
    • \n
  • \n

    DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.

    \n
    • \n
  • \n

    DocumentVersion: An SSM document version number. For example, 4.

    \n
    • \n
  • \n

    Classification: A patch classification. For example, security updates.

    \n
    • \n
  • \n

    PatchBaselineId: A patch baseline ID.

    \n
    • \n
  • \n

    PatchSeverity: A patch severity. For example, Critical.

    \n
    • \n
  • \n

    PatchState: A patch state. For example, InstancesWithFailedPatches.

    \n
    • \n
  • \n

    PatchGroup: The name of a patch group.

    \n
    • \n
  • \n

    InstalledTime: The time the association, patch, or custom compliance item was applied to\n the resource. Specify the time by using the following format:\n yyyy-MM-dd'T'HH:mm:ss'Z'\n

    \n
    • \n
" } }, "com.amazonaws.ssm#PutComplianceItemsRequest": { @@ -26013,7 +26013,7 @@ "Name": { "target": "com.amazonaws.ssm#PSParameterName", "traits": { - "smithy.api#documentation": "

The fully qualified name of the parameter that you want to create or update.

\n \n

You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name\n itself.

\n \n

The fully qualified name includes the complete hierarchy of the parameter path and name. For\n parameters in a hierarchy, you must include a leading forward slash character (/) when you create\n or reference a parameter. For example: /Dev/DBServer/MySQL/db-string13\n

\n

Naming Constraints:

\n
    \n
  • \n

    Parameter names are case sensitive.

    \n
    • \n
  • \n

    A parameter name must be unique within an Amazon Web Services Region

    \n
    • \n
  • \n

    A parameter name can't be prefixed with \"aws\" or \"ssm\"\n (case-insensitive).

    \n
    • \n
  • \n

    Parameter names can include only the following symbols and letters:\n a-zA-Z0-9_.-\n

    \n

    In addition, the slash character ( / ) is used to delineate hierarchies in parameter\n names. For example: /Dev/Production/East/Project-ABC/MyParameter\n

    \n
    • \n
  • \n

    A parameter name can't include spaces.

    \n
    • \n
  • \n

    Parameter hierarchies are limited to a maximum depth of fifteen levels.

    \n
    • \n
\n

For additional information about valid values for parameter names, see Creating Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

\n \n

The reported maximum length of 2048 characters for a parameter name includes 1037\n characters that are reserved for internal use by Systems Manager. The maximum length for a parameter name\n that you specify is 1011 characters.

\n

This count of 1011 characters includes the characters in the ARN that precede the name you\n specify. This ARN length will vary depending on your partition and Region. For example, the\n following 45 characters count toward the 1011 character maximum for a parameter created in the\n US East (Ohio) Region: arn:aws:ssm:us-east-2:111122223333:parameter/.

\n ", + "smithy.api#documentation": "

The fully qualified name of the parameter that you want to create or update.

\n \n

You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name\n itself.

\n \n

The fully qualified name includes the complete hierarchy of the parameter path and name. For\n parameters in a hierarchy, you must include a leading forward slash character (/) when you create\n or reference a parameter. For example: /Dev/DBServer/MySQL/db-string13\n

\n

Naming Constraints:

\n
    \n
  • \n

    Parameter names are case sensitive.

    \n
    • \n
  • \n

    A parameter name must be unique within an Amazon Web Services Region

    \n
    • \n
  • \n

    A parameter name can't be prefixed with \"aws\" or \"ssm\"\n (case-insensitive).

    \n
    • \n
  • \n

    Parameter names can include only the following symbols and letters:\n a-zA-Z0-9_.-\n

    \n

    In addition, the slash character ( / ) is used to delineate hierarchies in parameter\n names. For example: /Dev/Production/East/Project-ABC/MyParameter\n

    \n
    • \n
  • \n

    Parameter names can't contain spaces. The service removes any spaces specified for\n the beginning or end of a parameter name. If the specified name for a parameter contains spaces\n between characters, the request fails with a ValidationException error.

    \n
    • \n
  • \n

    Parameter hierarchies are limited to a maximum depth of fifteen levels.

    \n
    • \n
\n

For additional information about valid values for parameter names, see Creating Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

\n \n

The reported maximum length of 2048 characters for a parameter name includes 1037\n characters that are reserved for internal use by Systems Manager. The maximum length for a parameter name\n that you specify is 1011 characters.

\n

This count of 1011 characters includes the characters in the ARN that precede the name you\n specify. This ARN length will vary depending on your partition and Region. For example, the\n following 45 characters count toward the 1011 character maximum for a parameter created in the\n US East (Ohio) Region: arn:aws:ssm:us-east-2:111122223333:parameter/.

\n ", "smithy.api#required": {} } }, @@ -28450,7 +28450,7 @@ "AccessType": { "target": "com.amazonaws.ssm#AccessType", "traits": { - "smithy.api#documentation": "

\n Standard access type is the default for Session Manager sessions.\n JustInTime is the access type for Just-in-time node access.

" + "smithy.api#documentation": "

\n Standard access type is the default for Session Manager sessions.\n JustInTime is the access type for Just-in-time node access.

" } } }, @@ -30402,7 +30402,7 @@ } ], "traits": { - "smithy.api#documentation": "

Remove a label or labels from a parameter.

" + "smithy.api#documentation": "

Remove a label or labels from a parameter.

\n

Parameter names can't contain spaces. The service removes any spaces specified for the\n beginning or end of a parameter name. If the specified name for a parameter contains spaces\n between characters, the request fails with a ValidationException error.

" } }, "com.amazonaws.ssm#UnlabelParameterVersionRequest": { diff --git a/codegen/sdk/aws-models/synthetics.json b/codegen/sdk/aws-models/synthetics.json index 6631f3d8264..1f3851de98e 100644 --- a/codegen/sdk/aws-models/synthetics.json +++ b/codegen/sdk/aws-models/synthetics.json @@ -369,6 +369,12 @@ "smithy.api#documentation": "

The entry point to use for the source code when running the canary. For canaries that use the \n syn-python-selenium-1.0 runtime\n or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, \n the handler must be specified as \n fileName.handler. For \n syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as \n \n fileName.functionName\n , or\n you can specify a folder where canary scripts reside as \n\n folder/fileName.functionName\n .

", "smithy.api#required": {} } + }, + "Dependencies": { + "target": "com.amazonaws.synthetics#Dependencies", + "traits": { + "smithy.api#documentation": "

A list of dependencies that should be used for running this canary. Specify the dependencies as a key-value pair, where the key is the type of dependency and the value is the dependency reference.

" + } } }, "traits": { @@ -389,6 +395,12 @@ "traits": { "smithy.api#documentation": "

The entry point to use for the source code when running the canary.

" } + }, + "Dependencies": { + "target": "com.amazonaws.synthetics#Dependencies", + "traits": { + "smithy.api#documentation": "

A list of dependencies that are used for running this canary. The dependencies are specified as a key-value pair, where the key is the type of dependency and the value is the dependency reference.

" + } } }, "traits": { @@ -1284,6 +1296,50 @@ "smithy.api#output": {} } }, + "com.amazonaws.synthetics#Dependencies": { + "type": "list", + "member": { + "target": "com.amazonaws.synthetics#Dependency" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.synthetics#Dependency": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.synthetics#DependencyType", + "traits": { + "smithy.api#documentation": "

The type of dependency. Valid value is LambdaLayer.

" + } + }, + "Reference": { + "target": "com.amazonaws.synthetics#String", + "traits": { + "smithy.api#documentation": "

The dependency reference. For Lambda layers, this is the ARN of the Lambda layer. For more information \n about Lambda ARN format, see Lambda.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information about a dependency for a canary.

" + } + }, + "com.amazonaws.synthetics#DependencyType": { + "type": "enum", + "members": { + "LambdaLayer": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LambdaLayer" + } + } + } + }, "com.amazonaws.synthetics#DescribeCanaries": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/timestream-influxdb.json b/codegen/sdk/aws-models/timestream-influxdb.json index f40fbe769c7..d21181c31ed 100644 --- a/codegen/sdk/aws-models/timestream-influxdb.json +++ b/codegen/sdk/aws-models/timestream-influxdb.json @@ -1919,6 +1919,12 @@ "traits": { "smithy.api#enumValue": "db.influx.16xlarge" } + }, + "DB_INFLUX_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db.influx.24xlarge" + } } } }, diff --git a/codegen/sdk/aws-models/workspaces-thin-client.json b/codegen/sdk/aws-models/workspaces-thin-client.json index 82277c6cdfb..d5aa4934853 100644 --- a/codegen/sdk/aws-models/workspaces-thin-client.json +++ b/codegen/sdk/aws-models/workspaces-thin-client.json @@ -660,6 +660,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the device.

" } + }, + "lastUserId": { + "target": "com.amazonaws.workspacesthinclient#UserId", + "traits": { + "smithy.api#documentation": "

The user ID of the most recent session on the device.

" + } } }, "traits": { @@ -868,6 +874,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device.

" } + }, + "lastUserId": { + "target": "com.amazonaws.workspacesthinclient#UserId", + "traits": { + "smithy.api#documentation": "

The user ID of the most recent session on the device.

" + } } }, "traits": { @@ -3303,6 +3315,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspacesthinclient#UserId": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.workspacesthinclient#ValidationException": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/workspaces-web.json b/codegen/sdk/aws-models/workspaces-web.json index dbaae0668fa..2ec5f0fbaad 100644 --- a/codegen/sdk/aws-models/workspaces-web.json +++ b/codegen/sdk/aws-models/workspaces-web.json @@ -53,6 +53,9 @@ { "target": "com.amazonaws.workspacesweb#PortalResource" }, + { + "target": "com.amazonaws.workspacesweb#SessionLoggerResource" + }, { "target": "com.amazonaws.workspacesweb#TrustStoreResource" }, @@ -1093,6 +1096,121 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspacesweb#AssociateSessionLogger": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#AssociateSessionLoggerRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#AssociateSessionLoggerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a session logger with a portal.

", + "smithy.api#examples": [ + { + "title": "Associate Session Logger with Portal", + "documentation": "Associates a session logger with a portal", + "input": { + "portalArn": "arn:aws:workspaces-web:us-west-2:123456789012:portal/12345678-1234-1234-1234-123456789012", + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/11111111-1111-1111-1111-111111111111" + }, + "output": { + "portalArn": "arn:aws:workspaces-web:us-west-2:123456789012:portal/12345678-1234-1234-1234-123456789012", + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/11111111-1111-1111-1111-111111111111" + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/portals/{portalArn+}/sessionLogger", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#AssociateSessionLoggerRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the portal to associate to the session logger ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionLoggerArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

The ARN of the session logger to associate to the portal ARN.

", + "smithy.api#httpQuery": "sessionLoggerArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.workspacesweb#PortalResource" + }, + { + "resource": "com.amazonaws.workspacesweb#SessionLoggerResource" + } + ] + } + }, + "com.amazonaws.workspacesweb#AssociateSessionLoggerResponse": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the portal.

", + "smithy.api#required": {} + } + }, + "sessionLoggerArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the session logger.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.workspacesweb#PortalResource" + }, + { + "resource": "com.amazonaws.workspacesweb#SessionLoggerResource" + } + ] + } + }, "com.amazonaws.workspacesweb#AssociateTrustStore": { "type": "operation", "input": { @@ -1370,7 +1488,7 @@ "min": 2, "max": 131072 }, - "smithy.api#pattern": "\\{[\\S\\s]*\\}\\s*", + "smithy.api#pattern": "^\\{[\\S\\s]*\\}\\s*$", "smithy.api#sensitive": {} } }, @@ -1555,7 +1673,13 @@ } }, "com.amazonaws.workspacesweb#CertificateAuthorityBody": { - "type": "blob" + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32768 + } + } }, "com.amazonaws.workspacesweb#CertificateList": { "type": "list", @@ -2396,6 +2520,181 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspacesweb#CreateSessionLogger": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#CreateSessionLoggerRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#CreateSessionLoggerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a session logger.

", + "smithy.api#examples": [ + { + "title": "Create Session Logger with All Events", + "documentation": "Creates a session logger that captures all events and stores them in S3 with JSON format and flat folder structure", + "input": { + "eventFilter": { + "all": {} + }, + "logConfiguration": { + "s3": { + "bucket": "my-session-logs-bucket", + "keyPrefix": "session-logs/all/events", + "bucketOwner": "123456789012", + "logFileFormat": "Json", + "folderStructure": "Flat" + } + }, + "displayName": "Session Logger with All Events" + }, + "output": { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012" + } + }, + { + "title": "Create Session Logger with Specific Events", + "documentation": "Creates a session logger that captures only specific events with JSONLines format and nested folder structure", + "input": { + "eventFilter": { + "include": [ + "SessionStart", + "SessionEnd", + "UrlLoad", + "WebsiteInteract" + ] + }, + "logConfiguration": { + "s3": { + "bucket": "my-session-logs-bucket", + "keyPrefix": "session-logs/each/event", + "bucketOwner": "123456789012", + "logFileFormat": "JSONLines", + "folderStructure": "NestedByDate" + } + }, + "displayName": "Session Logger with Each Events", + "customerManagedKey": "arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012", + "additionalEncryptionContext": { + "EncryptionContextKey": "EncryptionContextValue" + }, + "tags": [ + { + "Key": "KEY-1", + "Value": "VALUE-1" + }, + { + "Key": "KEY-2", + "Value": "VALUE-2" + } + ] + }, + "output": { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321" + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/sessionLoggers", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#CreateSessionLoggerRequest": { + "type": "structure", + "members": { + "eventFilter": { + "target": "com.amazonaws.workspacesweb#EventFilter", + "traits": { + "smithy.api#documentation": "

The filter that specifies the events to monitor.

", + "smithy.api#required": {} + } + }, + "logConfiguration": { + "target": "com.amazonaws.workspacesweb#LogConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that specifies where logs are delivered.

", + "smithy.api#required": {} + } + }, + "displayName": { + "target": "com.amazonaws.workspacesweb#DisplayNameSafe", + "traits": { + "smithy.api#documentation": "

The human-readable display name for the session logger resource.

" + } + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn", + "traits": { + "smithy.api#documentation": "

The custom managed key of the session logger.

" + } + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "

The additional encryption context of the session logger.

" + } + }, + "tags": { + "target": "com.amazonaws.workspacesweb#TagList", + "traits": { + "smithy.api#documentation": "

The tags to add to the session logger.

" + } + }, + "clientToken": { + "target": "com.amazonaws.workspacesweb#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspacesweb#CreateSessionLoggerResponse": { + "type": "structure", + "members": { + "sessionLoggerArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the session logger.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.workspacesweb#SessionLoggerResource" + } + ] + } + }, "com.amazonaws.workspacesweb#CreateTrustStore": { "type": "operation", "input": { @@ -3252,6 +3551,79 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspacesweb#DeleteSessionLogger": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#DeleteSessionLoggerRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#DeleteSessionLoggerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a session logger resource.

", + "smithy.api#examples": [ + { + "title": "Delete Session Logger", + "documentation": "Deletes a session logger resource", + "input": { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/sessionLoggers/{sessionLoggerArn+}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#DeleteSessionLoggerRequest": { + "type": "structure", + "members": { + "sessionLoggerArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the session logger.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.workspacesweb#SessionLoggerResource" + } + ] + } + }, + "com.amazonaws.workspacesweb#DeleteSessionLoggerResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspacesweb#DeleteTrustStore": { "type": "operation", "input": { @@ -3692,21 +4064,94 @@ "smithy.api#output": {} } }, - "com.amazonaws.workspacesweb#DisassociateTrustStore": { + "com.amazonaws.workspacesweb#DisassociateSessionLogger": { "type": "operation", "input": { - "target": "com.amazonaws.workspacesweb#DisassociateTrustStoreRequest" + "target": "com.amazonaws.workspacesweb#DisassociateSessionLoggerRequest" }, "output": { - "target": "com.amazonaws.workspacesweb#DisassociateTrustStoreResponse" + "target": "com.amazonaws.workspacesweb#DisassociateSessionLoggerResponse" }, "errors": [ { "target": "com.amazonaws.workspacesweb#AccessDeniedException" }, - { - "target": "com.amazonaws.workspacesweb#ConflictException" - }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a session logger from a portal.

", + "smithy.api#examples": [ + { + "title": "Disassociate Session Logger from Portal", + "documentation": "Removes the association between a session logger and a portal", + "input": { + "portalArn": "arn:aws:workspaces-web:us-west-2:123456789012:portal/12345678-1234-1234-1234-123456789012" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/portals/{portalArn+}/sessionLogger", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workspacesweb#DisassociateSessionLoggerRequest": { + "type": "structure", + "members": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the portal to disassociate from the a session logger.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.workspacesweb#PortalResource" + } + ] + } + }, + "com.amazonaws.workspacesweb#DisassociateSessionLoggerResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspacesweb#DisassociateTrustStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#DisassociateTrustStoreRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#DisassociateTrustStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#ConflictException" + }, { "target": "com.amazonaws.workspacesweb#InternalServerException" }, @@ -3930,6 +4375,140 @@ "target": "com.amazonaws.workspacesweb#StringType" } }, + "com.amazonaws.workspacesweb#Event": { + "type": "enum", + "members": { + "WEBSITE_INTERACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WebsiteInteract" + } + }, + "FILE_DOWNLOAD_FROM_SECURE_BROWSER_TO_REMOTE_DISK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FileDownloadFromSecureBrowserToRemoteDisk" + } + }, + "FILE_TRANSFER_FROM_REMOTE_TO_LOCAL_DISK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FileTransferFromRemoteToLocalDisk" + } + }, + "FILE_TRANSFER_FROM_LOCAL_TO_REMOTE_DISK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FileTransferFromLocalToRemoteDisk" + } + }, + "FILE_UPLOAD_FROM_REMOTE_DISK_TO_SECURE_BROWSER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FileUploadFromRemoteDiskToSecureBrowser" + } + }, + "CONTENT_PASTE_TO_WEBSITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContentPasteToWebsite" + } + }, + "CONTENT_TRANSFER_FROM_LOCAL_TO_REMOTE_CLIPBOARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContentTransferFromLocalToRemoteClipboard" + } + }, + "CONTENT_COPY_FROM_WEBSITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContentCopyFromWebsite" + } + }, + "URL_LOAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UrlLoad" + } + }, + "TAB_OPEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TabOpen" + } + }, + "TAB_CLOSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TabClose" + } + }, + "PRINT_JOB_SUBMIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PrintJobSubmit" + } + }, + "SESSION_CONNECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SessionConnect" + } + }, + "SESSION_START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SessionStart" + } + }, + "SESSION_DISCONNECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SessionDisconnect" + } + }, + "SESSION_END": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SessionEnd" + } + } + } + }, + "com.amazonaws.workspacesweb#EventFilter": { + "type": "union", + "members": { + "all": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#documentation": "

The filter that monitors all of the available events, including any new events emitted in the future.

" + } + }, + "include": { + "target": "com.amazonaws.workspacesweb#Events", + "traits": { + "smithy.api#documentation": "

The filter that monitors only the listed set of events. New events are not auto-monitored.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter that specifies the events to monitor.

" + } + }, + "com.amazonaws.workspacesweb#Events": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#Event" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.workspacesweb#ExceptionMessage": { "type": "string" }, @@ -4002,6 +4581,23 @@ "com.amazonaws.workspacesweb#FieldName": { "type": "string" }, + "com.amazonaws.workspacesweb#FolderStructure": { + "type": "enum", + "members": { + "FLAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Flat" + } + }, + "NESTED_BY_DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NestedByDate" + } + } + } + }, "com.amazonaws.workspacesweb#GetBrowserSettings": { "type": "operation", "input": { @@ -4506,6 +5102,143 @@ "smithy.api#readonly": {} } }, + "com.amazonaws.workspacesweb#GetSessionLogger": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#GetSessionLoggerRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#GetSessionLoggerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about a specific session logger resource.

", + "smithy.api#examples": [ + { + "title": "Get Session Logger with All Events", + "documentation": "Retrieves a session logger configured for all events", + "input": { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012" + }, + "output": { + "sessionLogger": { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012", + "eventFilter": { + "all": {} + }, + "logConfiguration": { + "s3": { + "bucket": "my-session-logs-bucket-1", + "keyPrefix": "session-logs/all/events", + "bucketOwner": "123456789012", + "logFileFormat": "Json", + "folderStructure": "Flat" + } + }, + "displayName": "Session Logger with All Events", + "creationDate": "2024-01-15T10:30:00Z", + "associatedPortalArns": [ + "arn:aws:workspaces-web:us-west-2:123456789012:portal/87654321-4321-4321-4321-210987654321" + ] + } + } + }, + { + "title": "Get Session Logger with Specific Events", + "documentation": "Retrieves a session logger configured for specific events", + "input": { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321" + }, + "output": { + "sessionLogger": { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321", + "eventFilter": { + "include": [ + "SessionStart", + "SessionEnd", + "UrlLoad", + "WebsiteInteract" + ] + }, + "logConfiguration": { + "s3": { + "bucket": "my-session-logs-bucket-2", + "keyPrefix": "session-logs/each/event", + "bucketOwner": "123456789012", + "logFileFormat": "JSONLines", + "folderStructure": "NestedByDate" + } + }, + "displayName": "Session Logger with Each Events", + "customerManagedKey": "arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012", + "additionalEncryptionContext": { + "EncryptionContextKey": "EncryptionContextValue" + }, + "creationDate": "2024-01-15T14:45:00Z" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sessionLoggers/{sessionLoggerArn+}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#GetSessionLoggerRequest": { + "type": "structure", + "members": { + "sessionLoggerArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the session logger.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.workspacesweb#SessionLoggerResource" + } + ] + } + }, + "com.amazonaws.workspacesweb#GetSessionLoggerResponse": { + "type": "structure", + "members": { + "sessionLogger": { + "target": "com.amazonaws.workspacesweb#SessionLogger", + "traits": { + "smithy.api#documentation": "

The session logger details.

", + "smithy.api#nestedProperties": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspacesweb#GetSessionRequest": { "type": "structure", "members": { @@ -5409,7 +6142,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "arn:[\\w+=/,.@-]+:kinesis:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:stream/.+" + "smithy.api#pattern": "^arn:[\\w+=/,.@-]+:kinesis:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:stream/.+$" } }, "com.amazonaws.workspacesweb#ListBrowserSettings": { @@ -5895,13 +6628,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.workspacesweb#ListSessions": { + "com.amazonaws.workspacesweb#ListSessionLoggers": { "type": "operation", "input": { - "target": "com.amazonaws.workspacesweb#ListSessionsRequest" + "target": "com.amazonaws.workspacesweb#ListSessionLoggersRequest" }, "output": { - "target": "com.amazonaws.workspacesweb#ListSessionsResponse" + "target": "com.amazonaws.workspacesweb#ListSessionLoggersResponse" }, "errors": [ { @@ -5910,9 +6643,6 @@ { "target": "com.amazonaws.workspacesweb#InternalServerException" }, - { - "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" - }, { "target": "com.amazonaws.workspacesweb#ThrottlingException" }, @@ -5921,21 +6651,170 @@ } ], "traits": { - "smithy.api#documentation": "

Lists information for multiple secure browser sessions from a specific portal.

", - "smithy.api#http": { - "method": "GET", - "uri": "/portals/{portalId}/sessions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "sessions" - }, - "smithy.api#readonly": {} - } - }, + "smithy.api#documentation": "

Lists all available session logger resources.

", + "smithy.api#examples": [ + { + "title": "List All Session Loggers", + "documentation": "Lists all session loggers in the account without pagination", + "input": {}, + "output": { + "sessionLoggers": [ + { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012", + "logConfiguration": { + "s3": { + "bucket": "my-session-logs-bucket-1", + "keyPrefix": "session-logs/all/events", + "bucketOwner": "123456789012", + "logFileFormat": "Json", + "folderStructure": "Flat" + } + }, + "displayName": "Session Logger with All Events", + "creationDate": "2024-01-15T10:30:00Z" + }, + { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321", + "logConfiguration": { + "s3": { + "bucket": "my-session-logs-bucket-2", + "keyPrefix": "session-logs/each/event", + "bucketOwner": "123456789012", + "logFileFormat": "JSONLines", + "folderStructure": "NestedByDate" + } + }, + "displayName": "Session Logger with Each Events", + "creationDate": "2024-01-15T14:45:00Z" + } + ] + } + }, + { + "title": "List Session Loggers with Pagination", + "documentation": "Lists session loggers with pagination parameters", + "input": { + "maxResults": 1, + "nextToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" + }, + "output": { + "sessionLoggers": [ + { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/11111111-1111-1111-1111-111111111111", + "logConfiguration": { + "s3": { + "bucket": "my-session-logs-bucket-3", + "keyPrefix": "session-logs/pagination/example", + "bucketOwner": "123456789012", + "logFileFormat": "JSONLines", + "folderStructure": "Flat" + } + }, + "displayName": "Session Logger Example with Pagination", + "creationDate": "2024-03-15T12:45:00Z" + } + ], + "nextToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/sessionLoggers", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "sessionLoggers" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.workspacesweb#ListSessionLoggersRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "

The pagination token used to retrieve the next page of results for this operation.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.workspacesweb#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be included in the next page.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspacesweb#ListSessionLoggersResponse": { + "type": "structure", + "members": { + "sessionLoggers": { + "target": "com.amazonaws.workspacesweb#SessionLoggerList", + "traits": { + "smithy.api#documentation": "

The list of session loggers, including summaries of their details.

" + } + }, + "nextToken": { + "target": "com.amazonaws.workspacesweb#PaginationToken", + "traits": { + "smithy.api#documentation": "

The pagination token used to retrieve the next page of results for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspacesweb#ListSessions": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#ListSessionsRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#ListSessionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information for multiple secure browser sessions from a specific portal.

", + "smithy.api#http": { + "method": "GET", + "uri": "/portals/{portalId}/sessions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "sessions" + }, + "smithy.api#readonly": {} + } + }, "com.amazonaws.workspacesweb#ListSessionsRequest": { "type": "structure", "members": { @@ -6422,6 +7301,37 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspacesweb#LogConfiguration": { + "type": "structure", + "members": { + "s3": { + "target": "com.amazonaws.workspacesweb#S3LogConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for delivering the logs to S3.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the log.

" + } + }, + "com.amazonaws.workspacesweb#LogFileFormat": { + "type": "enum", + "members": { + "JSON_LINES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSONLines" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Json" + } + } + } + }, "com.amazonaws.workspacesweb#MaxConcurrentSessions": { "type": "integer", "traits": { @@ -6690,6 +7600,12 @@ "smithy.api#documentation": "

The ARN of the network settings that is associated with the web portal.

" } }, + "sessionLoggerArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the session logger that is assocaited with the portal.

" + } + }, "trustStoreArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { @@ -6746,7 +7662,12 @@ } }, "traits": { - "smithy.api#documentation": "

The web portal.

" + "smithy.api#documentation": "

The web portal.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.workspacesweb#SessionLoggerResource" + } + ] } }, "com.amazonaws.workspacesweb#PortalEndpoint": { @@ -6813,6 +7734,9 @@ "networkSettingsArn": { "target": "com.amazonaws.workspacesweb#ARN" }, + "sessionLoggerArn": { + "target": "com.amazonaws.workspacesweb#ARN" + }, "trustStoreArn": { "target": "com.amazonaws.workspacesweb#ARN" }, @@ -6875,6 +7799,9 @@ { "target": "com.amazonaws.workspacesweb#AssociateNetworkSettings" }, + { + "target": "com.amazonaws.workspacesweb#AssociateSessionLogger" + }, { "target": "com.amazonaws.workspacesweb#AssociateTrustStore" }, @@ -6896,6 +7823,9 @@ { "target": "com.amazonaws.workspacesweb#DisassociateNetworkSettings" }, + { + "target": "com.amazonaws.workspacesweb#DisassociateSessionLogger" + }, { "target": "com.amazonaws.workspacesweb#DisassociateTrustStore" }, @@ -6926,6 +7856,7 @@ "com.amazonaws.workspacesweb#AssociateUserSettingsRequest", "com.amazonaws.workspacesweb#AssociateUserAccessLoggingSettingsRequest", "com.amazonaws.workspacesweb#AssociateIpAccessSettingsRequest", + "com.amazonaws.workspacesweb#AssociateSessionLoggerRequest", "com.amazonaws.workspacesweb#AssociateTrustStoreRequest", "com.amazonaws.workspacesweb#GetPortalServiceProviderMetadataRequest", "com.amazonaws.workspacesweb#GetPortalServiceProviderMetadataResponse" @@ -7023,6 +7954,12 @@ "smithy.api#documentation": "

The ARN of the network settings that is associated with the web portal.

" } }, + "sessionLoggerArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the session logger that is assocaited with the portal.

" + } + }, "trustStoreArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { @@ -7061,7 +7998,12 @@ } }, "traits": { - "smithy.api#documentation": "

The summary of the portal.

" + "smithy.api#documentation": "

The summary of the portal.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.workspacesweb#SessionLoggerResource" + } + ] } }, "com.amazonaws.workspacesweb#QuotaCode": { @@ -7169,6 +8111,75 @@ "smithy.api#default": 0 } }, + "com.amazonaws.workspacesweb#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.workspacesweb#S3BucketOwner": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.workspacesweb#S3KeyPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\d\\w\\-_/!().*']+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.workspacesweb#S3LogConfiguration": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.workspacesweb#S3Bucket", + "traits": { + "smithy.api#documentation": "

The S3 bucket name where logs are delivered.

", + "smithy.api#required": {} + } + }, + "keyPrefix": { + "target": "com.amazonaws.workspacesweb#S3KeyPrefix", + "traits": { + "smithy.api#documentation": "

The S3 path prefix that determines where log files are stored.

" + } + }, + "bucketOwner": { + "target": "com.amazonaws.workspacesweb#S3BucketOwner", + "traits": { + "smithy.api#documentation": "

The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket.

" + } + }, + "logFileFormat": { + "target": "com.amazonaws.workspacesweb#LogFileFormat", + "traits": { + "smithy.api#documentation": "

The format of the LogFile that is written to S3.

", + "smithy.api#required": {} + } + }, + "folderStructure": { + "target": "com.amazonaws.workspacesweb#FolderStructure", + "traits": { + "smithy.api#documentation": "

The folder structure that defines the organizational structure for log files in S3.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The S3 log configuration.

" + } + }, "com.amazonaws.workspacesweb#SamlMetadata": { "type": "string", "traits": { @@ -7301,6 +8312,165 @@ "smithy.api#pattern": "^[a-zA-Z0-9\\-]+$" } }, + "com.amazonaws.workspacesweb#SessionLogger": { + "type": "structure", + "members": { + "sessionLoggerArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the session logger resource.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "sessionLoggerArn" + } + }, + "eventFilter": { + "target": "com.amazonaws.workspacesweb#EventFilter", + "traits": { + "smithy.api#documentation": "

The filter that specifies which events to monitor.

" + } + }, + "logConfiguration": { + "target": "com.amazonaws.workspacesweb#LogConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that specifies where logs are fowarded.

" + } + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn", + "traits": { + "smithy.api#documentation": "

The custom managed key of the session logger.

" + } + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "

The additional encryption context of the session logger.

" + } + }, + "associatedPortalArns": { + "target": "com.amazonaws.workspacesweb#ArnList", + "traits": { + "smithy.api#documentation": "

The associated portal ARN.

" + } + }, + "displayName": { + "target": "com.amazonaws.workspacesweb#DisplayNameSafe", + "traits": { + "smithy.api#documentation": "

The human-readable display name.

" + } + }, + "creationDate": { + "target": "com.amazonaws.workspacesweb#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the session logger resource was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The session logger resource.

" + } + }, + "com.amazonaws.workspacesweb#SessionLoggerList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#SessionLoggerSummary" + } + }, + "com.amazonaws.workspacesweb#SessionLoggerResource": { + "type": "resource", + "identifiers": { + "sessionLoggerArn": { + "target": "com.amazonaws.workspacesweb#ARN" + } + }, + "properties": { + "eventFilter": { + "target": "com.amazonaws.workspacesweb#EventFilter" + }, + "logConfiguration": { + "target": "com.amazonaws.workspacesweb#LogConfiguration" + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn" + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap" + }, + "associatedPortalArns": { + "target": "com.amazonaws.workspacesweb#ArnList" + }, + "displayName": { + "target": "com.amazonaws.workspacesweb#DisplayNameSafe" + }, + "creationDate": { + "target": "com.amazonaws.workspacesweb#Timestamp" + }, + "tags": { + "target": "com.amazonaws.workspacesweb#TagList" + } + }, + "create": { + "target": "com.amazonaws.workspacesweb#CreateSessionLogger" + }, + "read": { + "target": "com.amazonaws.workspacesweb#GetSessionLogger" + }, + "update": { + "target": "com.amazonaws.workspacesweb#UpdateSessionLogger" + }, + "delete": { + "target": "com.amazonaws.workspacesweb#DeleteSessionLogger" + }, + "list": { + "target": "com.amazonaws.workspacesweb#ListSessionLoggers" + }, + "traits": { + "aws.api#arn": { + "template": "{sessionLoggerArn}", + "absolute": true + }, + "aws.api#taggable": { + "property": "tags" + }, + "aws.cloudformation#cfnResource": { + "name": "SessionLogger" + } + } + }, + "com.amazonaws.workspacesweb#SessionLoggerSummary": { + "type": "structure", + "members": { + "sessionLoggerArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the session logger resource.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "sessionLoggerArn" + } + }, + "logConfiguration": { + "target": "com.amazonaws.workspacesweb#LogConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that specifies where the logs are fowarded.

" + } + }, + "displayName": { + "target": "com.amazonaws.workspacesweb#DisplayNameSafe", + "traits": { + "smithy.api#documentation": "

The human-readable display name.

" + } + }, + "creationDate": { + "target": "com.amazonaws.workspacesweb#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the session logger resource was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary of the session logger resource.

" + } + }, "com.amazonaws.workspacesweb#SessionSortBy": { "type": "enum", "members": { @@ -7392,7 +8562,7 @@ "min": 1, "max": 1024 }, - "smithy.api#pattern": ".*" + "smithy.api#pattern": "^.*$" } }, "com.amazonaws.workspacesweb#StringType": { @@ -8416,6 +9586,175 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspacesweb#UpdateSessionLogger": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspacesweb#UpdateSessionLoggerRequest" + }, + "output": { + "target": "com.amazonaws.workspacesweb#UpdateSessionLoggerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workspacesweb#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspacesweb#InternalServerException" + }, + { + "target": "com.amazonaws.workspacesweb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.workspacesweb#ThrottlingException" + }, + { + "target": "com.amazonaws.workspacesweb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the details of a session logger.

", + "smithy.api#examples": [ + { + "title": "Update Session Logger Event Filter", + "documentation": "Updates a session logger to capture specific events instead of all events", + "input": { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012", + "eventFilter": { + "include": [ + "SessionStart", + "SessionEnd", + "UrlLoad", + "WebsiteInteract" + ] + } + }, + "output": { + "sessionLogger": { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012", + "eventFilter": { + "include": [ + "SessionStart", + "SessionEnd", + "UrlLoad", + "WebsiteInteract" + ] + }, + "logConfiguration": { + "s3": { + "bucket": "my-session-logs-bucket", + "keyPrefix": "updated/session-logs/each/event", + "bucketOwner": "123456789012", + "logFileFormat": "Json", + "folderStructure": "Flat" + } + }, + "displayName": "Updated Session Logger with Specific Events", + "creationDate": "2024-01-15T10:30:00Z" + } + } + }, + { + "title": "Update Session Logger Configuration", + "documentation": "Updates the log configuration of a session logger", + "input": { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321", + "logConfiguration": { + "s3": { + "bucket": "updated-my-session-logs-bucket-2", + "keyPrefix": "updated/key/prefix", + "bucketOwner": "123456789012", + "logFileFormat": "Json", + "folderStructure": "Flat" + } + } + }, + "output": { + "sessionLogger": { + "sessionLoggerArn": "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321", + "eventFilter": { + "all": {} + }, + "logConfiguration": { + "s3": { + "bucket": "updated-my-session-logs-bucket-2", + "keyPrefix": "updated/key/prefix", + "bucketOwner": "123456789012", + "logFileFormat": "Json", + "folderStructure": "Flat" + } + }, + "displayName": "Updated Session Logger with Log Config", + "customerManagedKey": "arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012", + "additionalEncryptionContext": { + "EncryptionContextKey": "EncryptionContextValue" + }, + "creationDate": "2024-01-15T14:45:00Z" + } + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/sessionLoggers/{sessionLoggerArn+}", + "code": 200 + } + } + }, + "com.amazonaws.workspacesweb#UpdateSessionLoggerRequest": { + "type": "structure", + "members": { + "sessionLoggerArn": { + "target": "com.amazonaws.workspacesweb#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the session logger to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "eventFilter": { + "target": "com.amazonaws.workspacesweb#EventFilter", + "traits": { + "smithy.api#documentation": "

The updated eventFilter.

" + } + }, + "logConfiguration": { + "target": "com.amazonaws.workspacesweb#LogConfiguration", + "traits": { + "smithy.api#documentation": "

The updated logConfiguration.

" + } + }, + "displayName": { + "target": "com.amazonaws.workspacesweb#DisplayNameSafe", + "traits": { + "smithy.api#documentation": "

The updated display name.

" + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.workspacesweb#SessionLoggerResource" + } + ] + } + }, + "com.amazonaws.workspacesweb#UpdateSessionLoggerResponse": { + "type": "structure", + "members": { + "sessionLogger": { + "target": "com.amazonaws.workspacesweb#SessionLogger", + "traits": { + "smithy.api#documentation": "

The updated details of the session logger.

", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspacesweb#UpdateTrustStore": { "type": "operation", "input": { diff --git a/codegen/sdk/packages.json b/codegen/sdk/packages.json index 691b1112c22..6f83a7bddb9 100644 --- a/codegen/sdk/packages.json +++ b/codegen/sdk/packages.json @@ -24,6 +24,12 @@ "artifactName": "apigateway", "brazilName": "AwsSdkKotlinApiGateway" }, + { + "sdkId": "ARC Region switch", + "namespace": "aws.sdk.kotlin.services.arcregionswitch", + "artifactName": "arcregionswitch", + "brazilName": "AwsSdkKotlinArcRegionSwitch" + }, { "sdkId": "ARC Zonal Shift", "namespace": "aws.sdk.kotlin.services.arczonalshift", diff --git a/docs/targets.md b/docs/targets.md index 71442406b44..94a79d0be72 100644 --- a/docs/targets.md +++ b/docs/targets.md @@ -32,7 +32,7 @@ android { targetCompatibility = JavaVersion.VERSION_1_8 isCoreLibraryDesugaringEnabled = true } - kotlinOptions { + compilerOptions { jvmTarget = "1.8" } } @@ -49,4 +49,4 @@ The AWS SDK for Kotlin supports [native image compilation using GraalVM](https:/ Compiling native images is easily accomplished by applying [the GraalVM build plugin](https://github.com/graalvm/native-build-tools) to your application and running `./gradlew nativeCompile`. View [their getting started guide](https://graalvm.github.io/native-build-tools/latest/gradle-plugin-quickstart.html) for further details. -NOTE: [log4j2 does not currently support](https://github.com/apache/logging-log4j2/issues/1539) GraalVM native image compilation, so we recommend selecting a different logger implementation such as Logback. \ No newline at end of file +NOTE: [log4j2 does not currently support](https://github.com/apache/logging-log4j2/issues/1539) GraalVM native image compilation, so we recommend selecting a different logger implementation such as Logback. diff --git a/gradle.properties b/gradle.properties index 456bfd004b5..c0b7cf3837b 100644 --- a/gradle.properties +++ b/gradle.properties @@ -3,10 +3,10 @@ kotlin.mpp.stability.nowarn=true kotlin.native.ignoreDisabledTargets=true # gradle -org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G +org.gradle.jvmargs=-Xmx10g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.4.124-SNAPSHOT +sdkVersion=1.5.12-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/libs.versions.toml b/gradle/libs.versions.toml index 887e4478600..93018447b1b 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -1,26 +1,26 @@ [versions] -kotlin-version = "2.1.0" -ksp-version = "2.1.0-1.0.29" # Keep in sync with kotlin-version +kotlin-version = "2.2.0" +ksp-version = "2.2.0-2.0.2" # Keep in sync with kotlin-version dokka-version = "2.0.0" -aws-kotlin-repo-tools-version = "0.4.28-kn" +aws-kotlin-repo-tools-version = "0.4.30-kn" # libs -coroutines-version = "1.9.0" -atomicfu-version = "0.25.0" -binary-compatibility-validator-version = "0.16.3" +coroutines-version = "1.10.2" +atomicfu-version = "0.29.0" +binary-compatibility-validator-version = "0.18.0" # smithy-kotlin codegen and runtime are versioned separately -smithy-kotlin-runtime-version = "1.4.24-SNAPSHOT" -smithy-kotlin-codegen-version = "0.34.24-SNAPSHOT" +smithy-kotlin-runtime-version = "1.5.4-SNAPSHOT" +smithy-kotlin-codegen-version = "0.35.4-SNAPSHOT" # codegen smithy-version = "1.60.2" # testing ddb-local-version = "2.5.2" -junit-version = "5.10.5" +junit-version = "5.13.2" kotest-version = "5.9.1" kotlinx-benchmark-version = "0.4.12" kotlinx-serialization-version = "1.7.3" diff --git a/hll/build.gradle.kts b/hll/build.gradle.kts index 6de33363065..db502ca86e0 100644 --- a/hll/build.gradle.kts +++ b/hll/build.gradle.kts @@ -90,6 +90,12 @@ subprojects { freeCompilerArgs.add("-Xexpect-actual-classes") } } + + tasks.withType { + sourceCompatibility = JavaVersion.VERSION_1_8.toString() + targetCompatibility = JavaVersion.VERSION_1_8.toString() + } + tasks.withType { compilerOptions { freeCompilerArgs.add("-Xexpect-actual-classes") diff --git a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/api/dynamodb-mapper-schema-generator-plugin.api b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/api/dynamodb-mapper-schema-generator-plugin.api index 0e5ab1eafff..05259892c23 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/api/dynamodb-mapper-schema-generator-plugin.api +++ b/hll/dynamodb-mapper/dynamodb-mapper-schema-generator-plugin/api/dynamodb-mapper-schema-generator-plugin.api @@ -4,16 +4,6 @@ public final class aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPlug public fun apply (Lorg/gradle/api/Project;)V } -public final class aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPlugin$apply$1$1$inlined$sam$i$org_gradle_api_Action$0 : org/gradle/api/Action { - public fun (Lkotlin/jvm/functions/Function1;)V - public final synthetic fun execute (Ljava/lang/Object;)V -} - -public final class aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPlugin$inlined$sam$i$org_gradle_api_Action$0 : org/gradle/api/Action { - public fun (Lkotlin/jvm/functions/Function1;)V - public final synthetic fun execute (Ljava/lang/Object;)V -} - public class aws/sdk/kotlin/hll/dynamodbmapper/plugins/SchemaGeneratorPluginExtension { public fun ()V public final fun getDestinationPackage ()Laws/sdk/kotlin/hll/dynamodbmapper/codegen/annotations/DestinationPackage; diff --git a/hll/dynamodb-mapper/dynamodb-mapper/api/dynamodb-mapper.api b/hll/dynamodb-mapper/dynamodb-mapper/api/dynamodb-mapper.api index 6f000c92e6a..abda34f87ed 100644 --- a/hll/dynamodb-mapper/dynamodb-mapper/api/dynamodb-mapper.api +++ b/hll/dynamodb-mapper/dynamodb-mapper/api/dynamodb-mapper.api @@ -37,7 +37,7 @@ public abstract interface annotation class aws/sdk/kotlin/hll/dynamodbmapper/ann } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/AndExpr : aws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr { - public abstract fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; + public fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; public abstract fun getOperands ()Ljava/util/List; } @@ -61,7 +61,7 @@ public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/At } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath : aws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression { - public abstract fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; + public fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; public abstract fun getElement ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttrPathElement; public abstract fun getParent ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath; } @@ -94,7 +94,7 @@ public final class aws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributeType : } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/BetweenExpr : aws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr, aws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr { - public abstract fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; + public fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; public abstract fun getMax ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression; public abstract fun getMin ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression; public abstract fun getValue ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression; @@ -124,7 +124,7 @@ public final class aws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanFunc : j } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanFuncExpr : aws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr, aws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr { - public abstract fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; + public fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; public abstract fun getAdditionalOperands ()Ljava/util/List; public abstract fun getFunc ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanFunc; public abstract fun getPath ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath; @@ -154,7 +154,7 @@ public final class aws/sdk/kotlin/hll/dynamodbmapper/expressions/Comparator : ja } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/ComparisonExpr : aws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr, aws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr { - public abstract fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; + public fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; public abstract fun getComparator ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Comparator; public abstract fun getLeft ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression; public abstract fun getRight ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression; @@ -187,117 +187,117 @@ public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/Ex public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/Filter { public abstract fun and (Ljava/util/List;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun and ([Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun and ([Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun attr (Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath; public abstract fun contains (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun contains (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/lang/Object;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun contains (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/lang/Object;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Boolean;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Void;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/List;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Map;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eq-FrkygD8 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/UInt;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eq-X7ZSXPM (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/UShort;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eq-Zf_Lc9A (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/ULong;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eq-tA8902A (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/UByte;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eqSetByteArray (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eqSetNumber (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eqSetString (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eqSetUByte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eqSetUInt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eqSetULong (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun eqSetUShort (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Boolean;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Void;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/List;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Map;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eq-FrkygD8 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/UInt;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eq-X7ZSXPM (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/UShort;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eq-Zf_Lc9A (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/ULong;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eq-tA8902A (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/UByte;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eqSetByteArray (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eqSetNumber (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eqSetString (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eqSetUByte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eqSetUInt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eqSetULong (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun eqSetUShort (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun exists (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun get (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath; public abstract fun get (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath; public abstract fun getSize (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression; public abstract fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gt-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gt-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gt-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gt-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gt-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gt-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gt-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gt-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gte-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gte-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gte-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun gte-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gte-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gte-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gte-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun gte-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun isBetween (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isBetween (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;[B[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionByteArray (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isBetween (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;[B[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionByteArray (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun isInCollectionExpression (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionList (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionMap (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionNumber (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionSetByteArray (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionSetNumber (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionSetString (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionSetUByte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionSetUInt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionSetULong (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionSetUShort (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionString (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionUByte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionUInt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionULong (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInCollectionUShort (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInRangeNumber (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInRangeString (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInRangeUByte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInRangeUInt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInRangeULong (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun isInRangeUShort (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionList (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionMap (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionNumber (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionSetByteArray (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionSetNumber (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionSetString (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionSetUByte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionSetUInt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionSetULong (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionSetUShort (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionString (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionUByte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionUInt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionULong (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInCollectionUShort (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/util/Collection;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInRangeNumber (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInRangeString (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInRangeUByte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInRangeUInt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInRangeULong (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun isInRangeUShort (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun isOfType (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributeType;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lt-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lt-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lt-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lt-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lt-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lt-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lt-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lt-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lte-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lte-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lte-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun lte-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lte-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lte-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lte-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun lte-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Boolean;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Void;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/List;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Map;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neq-FrkygD8 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/UInt;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neq-X7ZSXPM (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/UShort;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neq-Zf_Lc9A (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/ULong;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neq-tA8902A (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/UByte;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neqSetByteArray (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neqSetNumber (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neqSetString (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neqSetUByte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neqSetUInt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neqSetULong (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun neqSetUShort (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Boolean;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/lang/Void;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/List;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Map;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neq-FrkygD8 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/UInt;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neq-X7ZSXPM (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/UShort;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neq-Zf_Lc9A (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/ULong;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neq-tA8902A (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Lkotlin/UByte;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neqSetByteArray (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neqSetNumber (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neqSetString (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neqSetUByte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neqSetUInt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neqSetULong (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun neqSetUShort (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun not (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun notExists (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun or (Ljava/util/List;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun or ([Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun or ([Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; public abstract fun startsWith (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun startsWith (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; - public abstract fun startsWith (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun startsWith (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; + public fun startsWith (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; } public final class aws/sdk/kotlin/hll/dynamodbmapper/expressions/Filter$DefaultImpls { @@ -396,7 +396,7 @@ public final class aws/sdk/kotlin/hll/dynamodbmapper/expressions/Filter$DefaultI } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/InExpr : aws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr { - public abstract fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; + public fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; public abstract fun getSet ()Ljava/util/Collection; public abstract fun getValue ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression; } @@ -420,7 +420,7 @@ public final class aws/sdk/kotlin/hll/dynamodbmapper/expressions/KeyFilterKt { } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/LiteralExpr : aws/sdk/kotlin/hll/dynamodbmapper/expressions/Expression { - public abstract fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; + public fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; public abstract fun getValue ()Laws/sdk/kotlin/services/dynamodb/model/AttributeValue; } @@ -451,7 +451,7 @@ public final class aws/sdk/kotlin/hll/dynamodbmapper/expressions/LiteralExprKt { } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/NotExpr : aws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr { - public abstract fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; + public fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; public abstract fun getOperand ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr; } @@ -464,7 +464,7 @@ public final class aws/sdk/kotlin/hll/dynamodbmapper/expressions/NotExprKt { } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/OrExpr : aws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr { - public abstract fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; + public fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; public abstract fun getOperands ()Ljava/util/List; } @@ -485,7 +485,7 @@ public final class aws/sdk/kotlin/hll/dynamodbmapper/expressions/ScalarFunc : ja } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/ScalarFuncExpr : aws/sdk/kotlin/hll/dynamodbmapper/expressions/BooleanExpr { - public abstract fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; + public fun accept (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ExpressionVisitor;)Ljava/lang/Object; public abstract fun getAdditionalOperands ()Ljava/util/List; public abstract fun getFunc ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/ScalarFunc; public abstract fun getPath ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/AttributePath; @@ -509,65 +509,65 @@ public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/So public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyFilter { public abstract fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/LiteralExpr;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun eq-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun eq-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun eq-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun eq-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun eq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun eq-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun eq-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun eq-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun eq-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; public abstract fun getSortKey ()Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey; public abstract fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/LiteralExpr;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gt-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gt-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gt-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gt-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gt-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gt-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gt-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gt-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; public abstract fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/LiteralExpr;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gte-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gte-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gte-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun gte-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gte-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gte-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gte-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun gte-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; public abstract fun isBetween (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/LiteralExpr;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/LiteralExpr;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun isBetween (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun isInRangeNumber (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun isInRangeString (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun isInRangeUByte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun isInRangeUInt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun isInRangeULong (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun isInRangeUShort (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun isBetween (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun isInRangeNumber (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun isInRangeString (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun isInRangeUByte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun isInRangeUInt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun isInRangeULong (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun isInRangeUShort (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Lkotlin/ranges/ClosedRange;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; public abstract fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/LiteralExpr;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lt-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lt-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lt-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lt-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lt (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lt-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lt-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lt-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lt-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; public abstract fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/LiteralExpr;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lte-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lte-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lte-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun lte-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lte (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lte-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lte-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lte-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun lte-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; public abstract fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/LiteralExpr;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun neq-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun neq-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun neq-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun neq-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/Number;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun neq (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun neq-2TYgG_w (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;J)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun neq-EK-6454 (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun neq-Qn1smSk (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;I)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun neq-i8woANY (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;S)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; public abstract fun startsWith (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Laws/sdk/kotlin/hll/dynamodbmapper/expressions/LiteralExpr;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun startsWith (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; - public abstract fun startsWith (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun startsWith (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;Ljava/lang/String;)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; + public fun startsWith (Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKey;[B)Laws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyExpr; } public final class aws/sdk/kotlin/hll/dynamodbmapper/expressions/SortKeyFilter$DefaultImpls { @@ -659,8 +659,10 @@ public final class aws/sdk/kotlin/hll/dynamodbmapper/items/HeterogeneousItemConv } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/items/ItemConverter : aws/sdk/kotlin/hll/mapping/core/converters/Converter { - public abstract fun convertTo (Ljava/lang/Object;)Laws/sdk/kotlin/hll/dynamodbmapper/model/Item; + public fun convertTo (Ljava/lang/Object;)Laws/sdk/kotlin/hll/dynamodbmapper/model/Item; + public synthetic fun convertTo (Ljava/lang/Object;)Ljava/lang/Object; public abstract fun convertTo (Ljava/lang/Object;Ljava/util/Set;)Laws/sdk/kotlin/hll/dynamodbmapper/model/Item; + public static synthetic fun convertTo$default (Laws/sdk/kotlin/hll/dynamodbmapper/items/ItemConverter;Ljava/lang/Object;Ljava/util/Set;ILjava/lang/Object;)Laws/sdk/kotlin/hll/dynamodbmapper/model/Item; } public final class aws/sdk/kotlin/hll/dynamodbmapper/items/ItemConverter$DefaultImpls { @@ -674,7 +676,7 @@ public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/items/ItemSche } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/items/ItemSchema$CompositeKey : aws/sdk/kotlin/hll/dynamodbmapper/items/ItemSchema$PartitionKey { - public abstract fun getKeyAttributeNames ()Ljava/util/Set; + public fun getKeyAttributeNames ()Ljava/util/Set; public abstract fun getSortKey ()Laws/sdk/kotlin/hll/dynamodbmapper/items/KeySpec; } @@ -683,7 +685,7 @@ public final class aws/sdk/kotlin/hll/dynamodbmapper/items/ItemSchema$CompositeK } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/items/ItemSchema$PartitionKey : aws/sdk/kotlin/hll/dynamodbmapper/items/ItemSchema { - public abstract fun getKeyAttributeNames ()Ljava/util/Set; + public fun getKeyAttributeNames ()Ljava/util/Set; public abstract fun getPartitionKey ()Laws/sdk/kotlin/hll/dynamodbmapper/items/KeySpec; } @@ -1200,18 +1202,18 @@ public final class aws/sdk/kotlin/hll/dynamodbmapper/pipeline/HResContextKt { } public abstract interface class aws/sdk/kotlin/hll/dynamodbmapper/pipeline/Interceptor { - public abstract fun modifyBeforeCompletion (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/HResContext;)Ljava/lang/Object; - public abstract fun modifyBeforeDeserialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/LResContext;)Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/DeserializeInput; - public abstract fun modifyBeforeInvocation (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/LReqContext;)Ljava/lang/Object; - public abstract fun modifyBeforeSerialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/HReqContext;)Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/SerializeInput; - public abstract fun readAfterDeserialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/HResContext;)V - public abstract fun readAfterInitialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/HReqContext;)V - public abstract fun readAfterInvocation (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/LResContext;)V - public abstract fun readAfterSerialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/LReqContext;)V - public abstract fun readBeforeCompletion (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/HResContext;)V - public abstract fun readBeforeDeserialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/LResContext;)V - public abstract fun readBeforeInvocation (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/LReqContext;)V - public abstract fun readBeforeSerialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/HReqContext;)V + public fun modifyBeforeCompletion (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/HResContext;)Ljava/lang/Object; + public fun modifyBeforeDeserialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/LResContext;)Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/DeserializeInput; + public fun modifyBeforeInvocation (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/LReqContext;)Ljava/lang/Object; + public fun modifyBeforeSerialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/HReqContext;)Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/SerializeInput; + public fun readAfterDeserialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/HResContext;)V + public fun readAfterInitialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/HReqContext;)V + public fun readAfterInvocation (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/LResContext;)V + public fun readAfterSerialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/LReqContext;)V + public fun readBeforeCompletion (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/HResContext;)V + public fun readBeforeDeserialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/LResContext;)V + public fun readBeforeInvocation (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/LReqContext;)V + public fun readBeforeSerialization (Laws/sdk/kotlin/hll/dynamodbmapper/pipeline/HReqContext;)V } public final class aws/sdk/kotlin/hll/dynamodbmapper/pipeline/Interceptor$DefaultImpls { diff --git a/tests/benchmarks/service-benchmarks/build.gradle.kts b/tests/benchmarks/service-benchmarks/build.gradle.kts index 62cc4457b82..95bfc94f1c5 100644 --- a/tests/benchmarks/service-benchmarks/build.gradle.kts +++ b/tests/benchmarks/service-benchmarks/build.gradle.kts @@ -5,8 +5,7 @@ import aws.sdk.kotlin.gradle.dsl.skipPublishing plugins { - id(libs.plugins.kotlin.multiplatform.get().pluginId) - alias(libs.plugins.aws.kotlin.repo.tools.kmp) + id(libs.plugins.kotlin.jvm.get().pluginId) application } @@ -41,7 +40,7 @@ kotlin { optinAnnotations.forEach { languageSettings.optIn(it) } } - jvmMain { + main { dependencies { api(libs.smithy.kotlin.runtime.core) implementation(project(":aws-runtime:aws-core"))